Skip to content

Latest commit

 

History

History
38 lines (22 loc) · 1.24 KB

README.md

File metadata and controls

38 lines (22 loc) · 1.24 KB
Raw

ebitengine-game-template

A basic skeleton for a 2D game using the Ebitengine library.

-----✂️-----

⚠️ After cloning this repository:

Write your OWN name name in the LICENSE file and find-and-replace ebitengine-game-template with your own game's name, for example, by running this command (tested on Linux and Mac):

grep -Rl ebitengine-game-template | xargs sed -i '' -e "s/ebitengine-game-template/${PWD##*/}/g"

it assumes that the game name is the name of the current folder because that is what go build will call it.

Then delete this section from the README, and start editing main.go to make your own game!

-----✂️-----

For game testers

Game controls:

  • F: toggle full-screen
  • Q: quit the game
  • Space: move up

For programmers

Make sure you have Go 1.22 or later to contribute to the game

To build the game yourself, run: go build . it will produce an ebitengine-game-template file and on Windows ebitengine-game-template.exe.

To run the tests, run: go test ./... but there are no tests yet.

The project has a very simple, flat structure, the first place to start looking is the main.go file.