- Realm of the Mad God (Bullet Hell Mechanics and Visuals)
- Top-Down Legend of Zelda (RPG/Boss Battles)
- Binding of Isaac (Unique Runs)
- Vampire Survivors (Endless Runs)
There are two ways to contribute.
I am currently working alone on this project- creating both the assets and the code. I do not have a job and am attending university, so any donations would help a ton. I could use the money to hire artists, since art is not my strong suite and I want this game to be the best it could be. (I am currently using a 5$ spritesheet lol).
Typescript is easy to develop with, as it is essentially just Javascript with type-safety. This project uses the Phaser game framework which makes it really easy to use JS knowledge to make a game for the web, and with the Tauri framework, we can then easily wrap web apps into a standalone cross-platform desktop app.
You can clone this repository, make changes, and then submit a pull request. Reach out to me on Discord (Dan Mizu#8420) if you are interested or have absolutely ANY questions.
- Install Node.js/npm, Rust, and Visual Studio Code
You can install Node.JS from: https://nodejs.org/en/
The LTS is fine. It should also install npm (a package manager) as well.
You can install Rust from: https://www.rust-lang.org/tools/install
Visual Studio Code is a great editor for web development and is obtained from: https://code.visualstudio.com/
You can use any other editor, though this project is configured with tasks and run configurations for VSCode.
- Clone this Repo
Theres a button for this at the top right of this repo. I personally use the Github Desktop app to clone repos easily.
- Open the Repo in Visual Studio Code and Install Dependencies
You can open the repo directly from Github Desktop after its been cloned. Use the shortcut CTRL+SHIFT+P (CMD+SHIFT+P on MacOS) and type and/or select Task: Run Tasks, then Install Dependencies.
- Develop
The games code is within the "src" directory and the game's assets are within "src/assets".
The main game scene is "src/scenes/Game.ts". I recommend skimming through it all to understand how it works.
- Debug
If using VSCode, you can use the "Run and Debug" tab on the left to run different configurations. Dev | Web will start a Vite server that can be accessed from the URL it gives you in the console. Dev | Tauri will run the Vite server, build the app, then launch it.
If you want to build the app yourself, you can use the Build task.
- Submit Changes For Review and Merging
When you're finished implementing a new feature/mechanic, push your changes (it will prompt you to fork the main repository) then submit a pull request to the main repository. This process is detailed here: https://github.com/firstcontributions/first-contributions.