Repository files navigation

Commonly called "onut". Game engine focused on rapid development. Aimed at Game Jams.

vartexture=getTexture("image.png");functionrender(){// Begin a batchSpriteBatch.begin();// Draw a sprite at screen coordinates x=200, y=100 from top left corner.SpriteBatch.drawSprite(texture,newVector2(200,100));// End and flush the batchSpriteBatch.end();}

functionupdate(dt){spriteAngle+=dt*45;// Will rotate 45 degree per second}functionrender(){    ...// Draw a sprite at with an animated angleSpriteBatch.drawSprite(texture,newVector2(200,100),Color.WHITE,spriteAngle);        ...}

Seeonut/samplesJS/ folders for more detailed samples.

• Global Game Jam 2020 -Arctic Distress

• Global Game Jam 2020 -Click to Repair

• Global Game Jam 2019 -Eagle's Nest

• Global Game Jam 2018 -Messenger Hacker

• Ottawa Game Jam 2017 -Sheep Dog Heroes

• Linux Game Jam 2017 -Retro Game War

• Ottawa Game Jam 2016 -Spy Satellite Showdown

• Global Game Jam 2016 -Fire Whisperers

• Ottawa Game Jam 2015 -Cannon Fodder Commander

• Onut 4.0 - The 3D release -TBD
• Onut 3.0 - The JavaScript release - Jul 14, 2017
• Onut 2.0 - The Cleanup release - Apr 3, 2016
• Onut 1.0 - Feb 6, 2016

1. Clone onut somewhere on your PC.
2. Generate using cmake.
3. Build the JSStandAlone project in release.
4. Copy the executable to your game's folder.

Recommended to use Visual Studio Code.

1. Create a folder for your game somehere on your PC
2. Copy[onut path]/jsconfig.json,[onut path]/typings/onut.d.ts to YourGame path.
3. Create asettings.txt file. Refer to samples to see what can be put in there.
4. Create assets and javascript files
5. main.js will always be the last JavaScript file executed, use it to initialize stuff.

functionupdate(dt){// Update your game here}functionrender(){}

Before you start. Please take note of the following folder structure. It is highly recommended for minimal setup time.The default asset search paths are configured for this structure.But it easy to add more usingoContentManager->addSearchPath.

• YourGame\
  • assets\ Put game assets in here
    • ...
  • src\ Your game source code (.h and .cpp)
  • .. projects files or your CMakeLists.txt

Make sure to define those 6 functions. Otherwise you will get unresolved errors.

voidinitSettings(){// Set Default game settings can be set using oSettings.}voidinit(){// Load your content.}voidshutdown(){// Cleanup.}voidupdate(){// Game logic.}voidrender(){// Game render.}voidpostRender(){// Render more stuff after post process.}voidrenderUI(){// Draw imgui debug UI.}

Look at samples to see what can be done here.

Sprite anims can be edited in Aseprite and exported as json. Certain flags can be set on frame's properties. Properties are colon ":" separated.

i.e.: "loop:genfliph:next=idle"

Frame properties and their meaning:

When exporting the sprite sheet in json format, make sure to change "Hash" to "Array".

Logo design by Pixilabs Software Inc.