project-ely

Project Ely

This is some game project that we are working on for fun.

This project is written in Go using raylib.

Setup

See the Setup Docs for installing all the necessary dependencies. It's fairly bare-bones, only requiring Go and raylib. Raylib bundles everything, so it really only depends on base graphics libs like X11.

This project uses Magefiles as an alternative to Makefiles. If you don't want to install Mage, it is optional. There is a wrapper Makefile available which will let you use the Magefiles without installing Mage.

Compile

Simply run mage or make to build the default binary.

You can build the binary directly with go build ./cmd/game/main.go as well, but it will be missing version information in addition to some other tweaks.

To create a release build, use mage release or make release.

For reference, the full command that mage release runs is the following:

go build -o project-ely \
	-tags 'netgo osusergo static static_build' \
	-buildmode pie \
	-ldflags '-X git.wisellama.rocks/Project-Ely/project-ely/internal/version.Version=project-ely-v0.0.1-23-g4a3ea60 -linkmode=external -extldflags "-static-pie" -s -w' \
	-trimpath \
	./cmd/game

To see all the available build targets, you can run mage -l or make list.

Licenses

Unless otherwise specified, the code for this project is licensed under the 2-Clause BSD license, a permissive open-source license. The short version is that you may use this code for any purpose so long as you give us credit for creating it. See LICENSE.md for more details.

Unless otherwise specified, the artwork assets and documentation (the non-code related things) for this project are licensed under the Creative Commons Attribution 4.0 International Public License. The short version is that you may use them for any purpose so long as you give us credit for creating them. See assets/LICENSE.md for more details and assets/legalcode.txt for the full license text.

Basically, so long as you give us credit for creating this game, you may use any parts of it for any purpose.

Additionally, the licenses for this project's dependencies can be found in the other_licenses directory.