Giter Club home page Giter Club logo

ikemen-go's Introduction

Ikemen GO

Ikemen GO is an open source fighting game engine that supports resources from the M.U.G.E.N engine, written in Google’s programming language, Go. 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 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 of this repository. You can find nightly builds here 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, macOS, and Linux.

Debugging

In order to run the compiled Ikemen GO executable, you will need to download the engine dependencies and unpack them into the Ikemen-GO source directory. After that, you can use Goland or Visual Studio Code 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.
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. It is recommend to read this page before submitting a bug report.

References

Name

"Ikemen" is an acronym of:

つまでも 成しない 遠に 完成 エンジン
Itsu made mo Kansei shinai Eien ni Mikansei ENgine

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 for more details.

ikemen-go's People

Contributors

k4thos avatar windblade-gr01 avatar potsmugen avatar neatunsou avatar samhocevar avatar lazin3ss avatar lint-action avatar eiton avatar wftk avatar jesuszilla avatar two4teezee avatar wily-coyote avatar garycxjk avatar superfromnd avatar danielporto avatar ambonmibable avatar realfoobs avatar nckgriva avatar dependabot[bot] avatar kasasagi77 avatar bwdyeti avatar wintermourn avatar joamjoamjoam avatar jmorphman avatar amavect avatar blac-dragoon avatar premiums-websites avatar romanthekat avatar ssvb avatar formula1 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.