1
Fork 0
mirror of https://github.com/redstrate/Kawari.git synced 2025-05-05 20:27:45 +00:00
Server emulator for a certain MMO
Find a file
2025-05-03 19:30:09 -04:00
.github/workflows Add run script to the artifact 2025-05-03 19:30:09 -04:00
resources Add setup page to download generated LauncherTweaks configs 2025-05-03 18:49:39 -04:00
scripts Add run script to the artifact 2025-05-03 19:30:09 -04:00
src Add setup page to download generated LauncherTweaks configs 2025-05-03 18:49:39 -04:00
.gitignore Add preliminary support for restoring character backups from Auracite 2025-03-30 18:52:00 -04:00
build.rs Send the welcome server message in the onBeginLogin Lua function 2025-03-28 23:00:32 -04:00
Cargo.lock Add Bootstrap styling to most web pages 2025-05-03 11:56:27 -04:00
Cargo.toml Add Bootstrap styling to most web pages 2025-05-03 11:56:27 -04:00
CONTRIBUTING.md Add better instructions on where to find updated opcodes 2025-05-03 12:48:41 -04:00
LICENSE Relicense to AGPL, remove .build.yml 2024-04-28 08:32:31 -04:00
README.md Detail the supported servers in the README 2025-05-03 12:53:22 -04:00
USAGE.md Simplify usage instructions with the new setup flow 2025-05-03 18:52:40 -04:00

Kawari

Server emulator for a certain MMO. Updates on the project can be found on my blog.

Features

We have a working implementation for most of FFXIV's servers:

  • Frontier
    • Used for news, gate status and more.
  • Launcher
    • Used to serve the launcher web page.
  • Lobby
    • Create a new character and login to a World server.
  • Login
    • Logging in and creating new accounts.
  • Patch
    • Verifies the game client version. Can't serve patch files yet.
  • World
    • Still limited, but supports basic multiplayer and can explore zones.

Goals

Kawari is primarily a research project, but also a way to preserve the modern client. Kawari is...

  • FOR preservation of the game, in the event that the servers are permanently unavailable.
  • FOR exploring the packet structure for legitimate purposes (e.g. archival and preservation.)
  • NOT a way to play the game without a valid subscription.
  • NOT for creating bots, packet modifications or doing anything on the retail servers.

Supported Game Version

Kawari currently supports patch 7.21 (2025.04.16.0000.0000.) Kawari will never "roll back" to a previous patch. There are other servers (e.g. Sapphire) that support older versions of the game. As Kawari moves to a new major patch, the previous patch is moved to a branch (e.g. 7.1) These branches are for archival: effectively unsupported, but still useful.

Only the Global region is supported. Only the Windows client is supported. Supporting other regions or clients are currently out of scope of this project, but might work anyway.

Running

Kawari is designed to be easy to run. A guide to running Kawari can be followed here.

Contributing

Pull requests for new features, patch updates, and documentation are welcome. A guide for contributing and updating Kawari can be found here.

Credits & Thank You

License

This project is licensed under the GNU Affero General Public License 3. Some code or assets may be licensed differently.