Enhanced JavaScript environment for PlayStation 2™

AthenaEnv is a project that seeks to facilitate and at the same time brings a complete kit for users to create homebrew software for PlayStation 2 using the JavaScript language. It has dozens of built-in functions, both for creating games and apps. The main advantage over using AthenaEnv project instead of the pure PS2SDK is above all the practicality, you will use one of the simplest possible languages to create what you have in mind, besides not having to compile, just script and test, fast and simple.

• System: Everything that involves files, folders and system stuff.
• Graphics: You can control the entire 2D part of your project, that is, draw images, shapes, lines, change their properties, etc.
• Render: 3D! Basic support for rendering a 3D environment in your project.
• Display: The entire screen of your project (2D and 3D), being able to change the resolution, enable or disable parameters.
• Font: Functions that control the texts that appear on the screen, loading texts, drawing and unloading from memory.
• Pads: Above being able to draw and everything else, A human interface is important. Supports rumble and pressure sensitivity.
• Timer: Control the time precisely in your code, it contains several timing functions.
• Sound: Basic sound functions.

New types are always being added and this list can grow a lot over time, so stay tuned.

• PS2DEV
• Duktape

In this section you will have some information about how to code using AthenaEnv, from prerequisites to useful functions and information about the language.

Using AthenaEnv you only need one way to code and one way to test your code, that is, if you want, you can even create your code on PS2, but I'll leave some recommendations below.

• PC: Visual Studio Code(with JavaScript extension) and PCSX2(1.7.0 or above, enabled HostFS is required) or PS2Client for test.

• How to enable HostFS on PCSX2 1.7.0:
  

• Android: QuickEdit and a PS2 with uLE for test.

Oh, and I also have to mention that an essential prerequisite for using AthenaEnv is knowing how to code in JavaScript.

AthenaEnv uses the Duktape 2.6.0 for JavaScript language, which means that it brings all ES5 JS features so far. Below is the list of usable functions of AthenaEnv project currently, this list is constantly being updated. Some custom modules are embedded, such as console, Node.js module loading and dofile/dostring from Lua.

Graphics functions:

Primitive shapes:

• Graphics.drawPixel(x, y, color)
• Graphics.drawRect(x, y, width, height, color)
• Graphics.drawLine(x, y, x2, y2, color)
• Graphics.drawCircle(x, y, radius, color, filled) *filled isn't mandatory
• Graphics.drawTriangle(x, y, x2, y2, x3, y3, color, color2, color3) *color2 and color3 are not mandatory
• Graphics.drawQuad(x, y, x2, y2, x3, y3, x4, y4 color, color2, color3, color4) *color2, color3 and color4 are not mandatory

Image functions:

• var image = Graphics.loadImage(path) *Supports BMP, JPG and PNG
• Graphics.drawImage(image, x, y, color)
• Graphics.drawRotateImage(image, x, y, angle, color)
• Graphics.drawScaleImage(image, x, y, scale_x, scale_y, color)
• Graphics.drawPartialImage(image, x, y, start_x, start_y, width, height, color)
• Graphics.drawImageExtended(image, x, y, start_x, start_y, width, height, scale_x, scale_y, angle, color)
• Graphics.setImageFilters(image, filter) *Choose between NEAREST and LINEAR filters
• var width = Graphics.getImageWidth(image)
• var height = Graphics.getImageHeight(image)
• Graphics.freeImage(image)

Asynchronous functions:

• Graphics.threadLoadImage(path) *Supports BMP, JPG and PNG
• var state = Graphics.getLoadState()
• var image = Graphics.getLoadData()

Render functions:

• Remember to enable zbuffering on screen mode, put the line of code below
• Default NTSC mode(3D enabled): Display.setMode(NTSC, 640, 448, CT24, INTERLACED, FIELD, true, Z16S)

• Render.init(aspect) *default aspect is 4/3, widescreen is 16/9
• var model = Render.loadOBJ(path, texture) *texture isn't mandatory
• Render.drawOBJ(model, pos_x, pos_y, pos_z, rot_x, rot_y, rot_z)
• Render.freeOBJ(model)

Camera functions:

• Camera.position(x, y, z)
• Camera.rotation(x, y, z)

Lights functions:

• Lights.create(count)
• Lights.set(light, dir_x, dir_y, dir_z, r, g, b, type)
  • Avaiable light types: AMBIENT, DIRECTIONAL

Display functions:

• Display.clear(color) *color isn't mandatory
• Display.flip()
• var freevram = Display.getFreeVRAM()
• var fps = Display.getFPS(frame_interval)
• Display.setVSync(bool)
• Display.waitVblankStart()
• Display.setMode(mode, width, height, colormode, interlace, field, zbuffering, zbuf_colormode)
  • Default NTSC mode(3D disabled): Display.setMode(NTSC, 640, 448, CT24, INTERLACED, FIELD)
  • Default NTSC mode(3D enabled): Display.setMode(NTSC, 640, 448, CT24, INTERLACED, FIELD, true, Z16S)
  • Default PAL mode(3D disabled): Display.setMode(PAL, 640, 512, CT24, INTERLACED, FIELD)
  • Default PAL mode(3D enabled): Display.setMode(PAL, 640, 512, CT24, INTERLACED, FIELD, true, Z16S)
  • Available modes: NTSC, _480p, PAL, _576p, _720p, _1080i
  • Available colormodes: CT16, CT16S, CT24, CT32
  • Available zbuffer colormodes: Z16, Z16S, Z24, Z32
  • Available interlaces: INTERLACED, NONINTERLACED
  • Available fields: FIELD, FRAME

Font functions:

Freetype functions(TTF, OTF):

• Font.ftInit()
• var font = Font.ftLoad("font.ttf")
• Font.ftPrint(font, x, y, align, width, height, text, color)
• Font.ftSetPixelSize()
• Font.ftUnload(font)
• Font.ftEnd()

Image functions(FNT, PNG, BMP):

• var font = Font.load("font.fnt/png/bmp")
• Font.print(font, x, y, scale, text, color)
• Font.unload(font)

ROM font functions:

• Font.fmLoad()
• Font.fmPrint(x, y, scale, text, color) *color isn't mandatory
• Font.fmUnload()

Pads functions:

• var pad = Pads.get(port) *port isn't mandatory
  • pad.btns - Buttons
  • pad.lx - Left analog horizontal position (left = -127, default = 0, right = 128)
  • pad.ly - Left analog vertical position (up = -127, default = 0, down = 128)
  • pad.rx - Right analog horizontal position (left = -127, default = 0, right = 128)
  • pad.ry - Right analog vertical position (up = -127, default = 0, down = 128)

  

• var type = Pads.getType(port) *port isn't mandatory
  • PAD_DIGITAL
  • PAD_ANALOG
  • PAD_DUALSHOCK

• var press = Pads.getPressure(port, button) *port isn't mandatory

• Pads.rumble(port, big, small) *port isn't mandatory

• var ret = Pads.check(pad, button)

• Buttons list:
  • PAD_SELECT
  • PAD_START
  • PAD_UP
  • PAD_RIGHT
  • PAD_DOWN
  • PAD_LEFT
  • PAD_TRIANGLE
  • PAD_CIRCLE
  • PAD_CROSS
  • PAD_SQUARE
  • PAD_L1
  • PAD_R1
  • PAD_L2
  • PAD_R2
  • PAD_L3
  • PAD_R3

System functions:

• var fd = System.openFile(path, type)
• Types list:
  • FREAD
  • FWRITE
  • FCREATE
  • FRDWR
• var buffer = System.readFile(file, size)
• System.writeFile(fd, data, size)
• System.closeFile(fd)
• System.seekFile(fd, pos, type)
• Types list:
  • SET
  • CUR
  • END
• var size = System.sizeFile(fd)
• System.doesFileExist(path)
• System.CurrentDirectory(path) *if path given, it sets the current dir, else it gets the current dir
• var listdir = System.listDir(path) *path isn't mandatory
  • listdir[index].name - return file name on indicated index(string)
  • listdir[index].size - return file size on indicated index(integer)
  • listdir[index].directory - return if indicated index is a file or a directory(bool)
• System.createDirectory(path)
• System.removeDirectory(path)
• System.removeFile(path)
• System.copyFile(source, dest)
• System.moveFile(source, dest)
• System.rename(source, dest)
• System.sleep(sec)
• var freemem = System.getFreeMemory()
• System.exitToBrowser()
• var info = System.getMCInfo(slot)
  • info.type
  • info.freemem
  • info.format

Asynchronous functions:

• System.threadCopyFile(source, dest)
• var progress = System.getFileProgress()
  • progress.current
  • progress.final

Timer functions:

• var timer = Timer.new()
• Timer.getTime(timer)
• Timer.setTime(src, value)
• Timer.destroy(timer)
• Timer.pause(timer)
• Timer.resume(timer)
• Timer.reset(timer)
• Timer.isPlaying(timer)

Sound functions:

• Sound.setFormat(bitrate, freq, channels)
• Sound.setVolume(volume)
• Sound.setADPCMVolume(channel, volume)
• var audio = Sound.loadADPCM(path)
• Sound.playADPCM(channel, audio)

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AwesomeFeature)
3. Commit your Changes (git commit -m 'Add some AwesomeFeature')
4. Push to the Branch (git push origin feature/AwesomeFeature)
5. Open a Pull Request

Distributed under GNU GPL-3.0 License. See LICENSE for more information.

Daniel Santos - @danadsees - [email protected]

Project Link: https://github.com/DanielSant0s/AthenaEnv

Here are some direct and indirect thanks to the people who made the project viable!

• guiprav - for 3dcb-duktape, which was the inspiration for bringing Enceladus and JavaScript together
• HowlingWolf&Chelsea - Tests, tips and many other things
• Whole PS2DEV team