Skip to content

nickname2002/the-odyssey-of-a-knight-into-the-retroverse

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 

Repository files navigation

The Odyssey of a Knight | Into the Retro-Verse

A game created for the Summer of GameDev 2023 game jam, inspired by the theme Retro Remix. It's a 2D platformer, drawing inspiration from the original Super Mario Bros. game and featuring characters from various retro game classics. The game is built using the JorCademy Engine.

Table of Contents


Game Structure

The game is comprised of the following files and folders. The folders contain classes for game logic and assets. The main.py file initiates the game. Detailed descriptions of these files are omitted, as they pertain more to the engine itself than to gameplay development.

├── JorCademy-Engine
│   ├── Environment
│   ├── GameObject
│   ├── LICENSE
│   ├── Level
│   ├── Loot
│   ├── Maps
│   ├── Pipfile
│   ├── Pipfile.lock
│   ├── Support
│   ├── UI
│   ├── __pycache__
│   ├── assets
│   ├── events.py
│   ├── game.py
│   ├── jorcademy.py
│   ├── main.py
│   ├── primitives.py
│   └── readme.md
├── readme.md
└── venv
    ├── bin
    ├── include
    ├── lib
    └── pyvenv.cfg

Dependencies

The game relies on the JorCademy Engine, built atop the Pygame and Pygbag libraries. Since these libraries aren't included in the standard Python installation, they must be installed separately using pip. Refer to the JorCademy Engine's Dependencies section for installation instructions.

Running the Application

To launch the application locally, use the following terminal command:

python3 JorCademy-Engine/main.py

If this command fails, you can try python JorCademy-Engine/main.py or simply JorCademy-Engine/main.py, depending on your Python version and operating system.

Controls

The game is controlled using a keyboard or controller. The following keys/buttons are used:

  • W/UP/SPACE/B/A: Jump
  • A/LEFT/D_LEFT: Move left
  • D/RIGHT/D_RIGHT: Move right
  • SHIFT/Y: Attack
  • ESC/X: Pause the game

Note: The D suffix indicates the D-pad on a game controller.

Supported Peripherals

The game currently supports the following peripherals:

  • Keyboard
  • Nintendo® Switch Pro Controller

Maintenance

This project will be actively maintained until the conclusion of the game jam on 19/08/2023. Afterward, no further updates are expected.

Credits

Art

This game uses assets made by the following artists:

Music

The game features captivating music composed by the following artists:

The final track is promoted by BreakingCopyright:

 • 💌 Royalty Free Romantic Piano Music -...

Known issues

The game is currently in the last stage of development. The following issues are known and will be fixed before the game jam deadline:

  • Click events are not very responsive. This means that the player must likely click the button multiple times to get a response. This is a known issue with the JorCademy Engine, and will be fixed in a future update.
  • Sometimes, controller connection might not be detected. In order to fix this, restart the game.

Contact

If you have any questions or feedback, feel free to reach out: nickjordan2002@gmail.com

Releases

No releases published

Packages

No packages published

Languages