Skip to content

EmuLinker-K is a server that facilitates emulator netplay using the Kaillera protocol.

License

Notifications You must be signed in to change notification settings

smash64-dev/EmuLinker-K

 
 

Repository files navigation

Maintained build Make a pull request

Watch on GitHub Star on GitHub Tweet

EmuLinker-K

EmuLinker-K is a server that uses the Kaillera protocol to facilitate online multiplayer for emulators.

EmuLinker-K is a Kotlin rewrite of EmulinkerSF, with an emphasis on measuring and improving performance, patching security and privacy vulnerabilities, and adding useful features for both server owners and users. EmuLinker-K is maintained by nue.

Feel free to file bugs and feature requests on this repository, or find our channel in the Kaillera Reborn discord:

Discord

Getting Started

If you want to start a new server, see our Releases page for the latest stable release.

// TODO(nue): Write better instructions, including how to work with charsets.

Development

From the root directory, you can perform common tasks with the following commands:

Command Description
./gradlew clean Clean build resources.
./gradlew compileKotlin Compile the code.
./gradlew test Run unit tests.
./gradlew run Run the server locally.
./gradlew jar -PprodBuild=true Build the jar used for PROD.
./gradlew spotlessCheck Run the linter.
./gradlew spotlessApply Run the formatter.
./gradlew tasks See a full list of available commands.

Intellij IDEA is recommended for writing code for this repository.

Documentation

KDoc documentation is automatically published to https://hopskipnfall.github.io/EmuLinker-K.

About

EmuLinker-K is a server that facilitates emulator netplay using the Kaillera protocol.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Kotlin 100.0%