/EmuLinkerSF-netsma

EmuLinkerSF-netsma is a SSB64 Netplay fork of EmuLinkerSF

Primary LanguageKotlinGNU General Public License v2.0GPL-2.0

Maintained build Make a pull request

Watch on GitHub Star on GitHub Tweet

EmuLinkerSF-netsma

EmuLinkerSF-netsma (ネトスマ) is a SSB64-specific (originally just Japan-focused) fork of EmulinkerSF, which again is a fork of EmuLinker.

The aim of this repository is to:

  • Add new features useful to SSB64 netplay.
  • Modernize the codebase and fix vulnerabilities while maintaining or increasing the level of performance.

EmuLinkerSF-netsma is maintained by 鵺 (nue).

Development

From the emulinker/ directory, the following commands are supported:

Command Description
mvn compile Compile the code. Running this command also patches ErrorProne suggestions.
mvn spotless:apply Run the formatter.
mvn spotless:check Run the linter.
mvn test Run tests.
mvn assembly:single Build the jar.
mvn exec:java Run the server locally.

Note: You will need to have Maven installed.

Deployment

// TODO(nue): Write deployment steps here.

Note: If you use non-ASCII characters in the conf/language.properties file, you need to run with at least Java 9 for the characters to appear correctly.

Docker

Docker support is WIP.

To run locally with Docker:

docker-compose up -d

To run locally with Docker and a local Graphite instance to monitor metrics (note: you need to also set metrics.enabled=true in emulinker.cfg):

docker-compose --profile=debug up -d

You can then access the Graphite dashboard at http://localhost/dashboard