https://github.com/ikemen-engine/Ikemen-GO
An open-source fighting game engine that supports MUGEN resources.
https://github.com/ikemen-engine/Ikemen-GO
game-engine gamedev go golang
Last synced: 6 days ago
JSON representation
An open-source fighting game engine that supports MUGEN resources.
- Host: GitHub
- URL: https://github.com/ikemen-engine/Ikemen-GO
- Owner: ikemen-engine
- License: other
- Created: 2019-01-21T13:39:54.000Z (over 6 years ago)
- Default Branch: develop
- Last Pushed: 2025-05-08T09:06:09.000Z (9 days ago)
- Last Synced: 2025-05-08T10:23:07.002Z (9 days ago)
- Topics: game-engine, gamedev, go, golang
- Language: Go
- Homepage: https://ikemen-engine.github.io
- Size: 26.9 MB
- Stars: 1,003
- Watchers: 55
- Forks: 140
- Open Issues: 172
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: License.txt
Awesome Lists containing this project
- trackawesomelist - Ikemen GO (⭐1k) - An open-source fighting game engine that supports MUGEN resources. Written in Go. (Recently Updated / [May 09, 2025](/content/2025/05/09/README.md))
README
# Ikemen GO
Ikemen GO is an open source fighting game engine that supports resources from the [M.U.G.E.N](https://en.wikipedia.org/wiki/Mugen_(game_engine)) engine, written in Google’s programming language, [Go](https://go.dev/). It is a complete rewrite of a prior engine known simply as Ikemen.
## Features
Ikemen GO aims for backwards-compatibility on par with M.U.G.E.N version 1.1 Beta, while simultaneously expanding on its features in a variety of ways.
Refer to [our wiki](https://github.com/ikemen-engine/Ikemen-GO/wiki) to see a comprehensive list of new features that have been added in Ikemen GO.
## Installing
Ready to use builds for Windows, macOS and Linux can be found in the [releases section](https://github.com/ikemen-engine/Ikemen-GO/releases) of this repository. You can find nightly builds [here](https://github.com/ikemen-engine/Ikemen-GO/releases/tag/nightly) as well, which update on every commit.
## Running
Download the ZIP archive that matches your operating system and extract its contents to your preferred location.
On Windows, double-click `Ikemen_GO.exe` (`Ikemen_GO_x86.exe` on 32-bit OSes).
On macOS or Linux, double-click `Ikemen_GO.command`.
## Developing
These instructions are for those interested in developing the Ikemen GO engine itself. Instructions for creating custom stages, fonts, characters and other resources can be found in the community forum.
### Building
You can find instructions for building Ikemen GO on our wiki. Instructions are available for [Windows](https://github.com/ikemen-engine/Ikemen-GO/wiki/Building,-Installing-and-Distributing#building-on-windows), [macOS](https://github.com/ikemen-engine/Ikemen-GO/wiki/Building,-Installing-and-Distributing#building-on-macos), and [Linux](https://github.com/ikemen-engine/Ikemen-GO/wiki/Building,-Installing-and-Distributing#building-on-linux).
### Debugging
In order to run the compiled Ikemen GO executable, you will need to download the [engine dependencies](https://github.com/ikemen-engine/Ikemen_GO-Elecbyte-Screenpack) and unpack them into the Ikemen-GO source directory. After that, you can use [Goland](https://www.jetbrains.com/go/) or [Visual Studio Code](https://code.visualstudio.com/) to debug.
### Cross-compiling binaries with Docker (Linux/Windows/MacOS)
The easiest way to compile binaries for other platforms is with Docker.
You don't need the native development environment set to be able to build binaries if you decide to use Docker.
The image downloaded has all the required tools to compile Ikemen GO for all three major platforms.
Install [Docker for your platform](https://www.docker.com/get-started).
For macOS, you can install Docker using Homebrew (`brew cask install docker`).
Open a terminal, go to the Ikemen `build` directory folder and then run the script `build_docker.sh`. Look inside the script for details on how it works.
## Troubleshooting
If you run into any issues with Ikemen Go, you can report it on our [issue tracker](https://github.com/ikemen-engine/Ikemen-GO/issues). It is recommend to read [this page](https://github.com/ikemen-engine/Ikemen-GO/blob/develop/CONTRIBUTING.md) before submitting a bug report.
## References
- [The original reposity of Ikemen GO.](https://osdn.net/users/supersuehiro/pf/ikemen_go/) This project was forked from this repository due to its original author seemingly abandoning the project.
- [The default motif bundled with the engine.](https://github.com/ikemen-engine/Ikemen_GO-Elecbyte-Screenpack) Note that this motif is licensed under CC-BY 3 rather than Ikemen GO's source, which is MIT.
## Name
"Ikemen" is an acronym of:
**い**つまでも **完**成しない **永**遠に **未**完成 **エン**ジン
**I**tsu made mo **K**ansei shinai **E**ien ni **M**ikansei **EN**gine
## License
Ikemen GO's source code is available under the MIT License. Certain non-code assets are licensed under CC-BY 3.0.
See [License.txt](License.txt) for more details.