https://github.com/redstrate/kawari
Substitute for some official FFXIV servers
https://github.com/redstrate/kawari
ffxiv final-fantasy-14 final-fantasy-xiv
Last synced: 14 days ago
JSON representation
Substitute for some official FFXIV servers
- Host: GitHub
- URL: https://github.com/redstrate/kawari
- Owner: redstrate
- License: agpl-3.0
- Created: 2024-04-28T12:26:29.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-06-29T19:06:53.000Z (10 months ago)
- Last Synced: 2024-07-01T00:20:09.783Z (10 months ago)
- Topics: ffxiv, final-fantasy-14, final-fantasy-xiv
- Language: Rust
- Homepage: https://xiv.zone/kawari
- Size: 70.3 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Kawari
Server emulator for a certain MMO. Updates on the project can be found [on my blog](https://redstrate.com/blog/series/kawari-progress-report/).
## 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.20h**. 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.
## Running
Kawari is designed to be easy to run. A guide to running Kawari can be followed [here](USAGE.md).
## Contributing
Pull requests for new features, patch updates, and documentation are welcome. A guide for contributing and updating Kawari can be found [here](CONTRIBUTING.md).
## Credits & Thank You
* [Sapphire](https://github.com/SapphireServer/Sapphire) for reference.
* [iolite](https://github.com/0xbbadbeef/iolite) for inspiration & reference.
* [TemporalStasis](https://github.com/NotNite/TemporalStasis) for tooling and reference.
* [Project Chronofoil](https://github.com/ProjectChronofoil/) for easy packet capture.
* [FFXIVClientStructs](https://github.com/aers/FFXIVClientStructs/) for being an invaluable resource for the client's internals.
## License
This project is licensed under the [GNU Affero General Public License 3](https://github.com/redstrate/Kawari/blob/master/LICENSE). Some code or assets may be licensed differently.