Skip to content

celestialfault/wfgm-sync-server

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

24 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

wfgm-sync-server

A minimal web server built with FastAPI, providing cloud sync capabilities for Wildfire's Female Gender Mod.

Running your own

This requires the following to run:

  • A MongoDB server with replication support enabled
    • MongoDB Atlas provides free databases with to 512 MB of storage, suitable for local development
  • Python 3.10 or newer
  • Poetry
git clone https://github.com/celestialfault/wfgm-sync-server.git
cd wfgm-sync-server
poetry install --only main
poetry run fastapi run

Afterward, point the mod at your server by setting cloud_server in config/wildfire_gender.json to your server, such as https://wfgm.example.com.

Note that there is a known issue where the mod will fail to sync player data to the server if it isn't running over HTTPS - this issue is automatically worked around if you're in a development environment (to allow for local development), but this otherwise effectively forces an HTTPS requirement for production deployments (which you should already be doing to begin with).

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Languages