{"id":31563394,"url":"https://github.com/fosterg4/wicked-waifus-rs","last_synced_at":"2025-10-05T04:59:00.034Z","repository":{"id":307965329,"uuid":"1031215512","full_name":"FosterG4/wicked-waifus-rs","owner":"FosterG4","description":null,"archived":false,"fork":false,"pushed_at":"2025-08-03T09:19:58.000Z","size":8100,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-08-03T11:22:54.625Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/FosterG4.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-08-03T09:09:57.000Z","updated_at":"2025-08-03T09:20:01.000Z","dependencies_parsed_at":"2025-08-03T11:37:40.875Z","dependency_job_id":null,"html_url":"https://github.com/FosterG4/wicked-waifus-rs","commit_stats":null,"previous_names":["fosterg4/wicked-waifus-rs"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/FosterG4/wicked-waifus-rs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FosterG4%2Fwicked-waifus-rs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FosterG4%2Fwicked-waifus-rs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FosterG4%2Fwicked-waifus-rs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FosterG4%2Fwicked-waifus-rs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/FosterG4","download_url":"https://codeload.github.com/FosterG4/wicked-waifus-rs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FosterG4%2Fwicked-waifus-rs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278411254,"owners_count":25982368,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-05T02:00:06.059Z","response_time":54,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-10-05T04:58:56.654Z","updated_at":"2025-10-05T04:59:00.029Z","avatar_url":"https://github.com/FosterG4.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Wicked Waifus (Fork)\n\n![Screenshot](screenshot.png)\n\n## About\n\n**This is a fork of the original Wicked Waifus project** - an Wuthering Waves server emulator written in Rust. \n\n**Original Repository**: [https://git.xeondev.com/wickedwaifus/wicked-waifus-rs](https://git.xeondev.com/wickedwaifus/wicked-waifus-rs)\n\nThis fork has been customized for easier installation and setup with additional environment configurations and improvements. For the most up-to-date version and original development, please visit the original repository.\n\nThe goal of this project is to ensure a clean, easy-to-deploy code environment\n\n## Getting started\n\n#### Requirements\n- [Rust](https://www.rust-lang.org/tools/install) (latest stable version)\n- [PostgreSQL](https://www.postgresql.org/download/) (version 12 or higher)\n- [Protoc](https://github.com/protocolbuffers/protobuf/releases) (for protobuf codegen)\n- [Git](https://git-scm.com/downloads) (for cloning the repository)\n- [Git LFS](https://git-lfs.github.com/) (for large file handling)\n- [Docker Desktop](https://www.docker.com/products/docker-desktop/) (optional, for containerized setup)\n\n#### Environment Setup\n\nBefore starting, ensure your environment is properly configured:\n\n1. **Rust Environment**:\n   ```sh\n   # Install Rust if not already installed\n   curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh\n   source ~/.cargo/env\n   \n   # Update Rust to latest version\n   rustup update\n   ```\n\n2. **PostgreSQL Setup**:\n   ```sh\n   # Create database (adjust credentials as needed)\n   createdb wicked_waifus_db\n   # Or using psql:\n   psql -U postgres -c \"CREATE DATABASE wicked_waifus_db;\"\n   ```\n\n3. **Protobuf Compiler**:\n   ```sh\n   # On Ubuntu/Debian\n   sudo apt install protobuf-compiler\n   \n   # On macOS\n   brew install protobuf\n   \n   # On Windows (using Chocolatey)\n   choco install protoc\n   ```\n\n4. **Git LFS Setup** (for large game data files):\n   ```sh\n   # Install Git LFS\n   git lfs install\n   \n   # Track large JSON files\n   git lfs track \"*.json\"\n   git lfs track \"data/assets/**/*.json\"\n   git lfs track \"assets/**/*.json\"\n   ```\n\n#### Environment Variables\n\nSet up your environment variables using the provided `.env.example` file:\n\n```sh\n# Copy the example environment file\ncp .env.example .env\n\n# Edit the .env file with your specific settings\n# On Windows:\nnotepad .env\n# On Linux/macOS:\nnano .env\n# Or use your preferred editor:\ncode .env\n```\n\nThe `.env.example` file contains all necessary environment variables including:\n- Database configuration (host, port, credentials)\n- Server ports for each service\n- Development settings (logging, debug mode)\n- Optional custom paths and URLs\n\n#### Setup Options\n\n##### Option A: Building from sources (Recommended)\n\n```sh\n# Clone this fork with LFS files\ngit clone --recursive https://github.com/FosterG4/wicked-waifus-rs.git\ncd wicked-waifus-rs\n\n# Pull LFS files\ngit lfs pull\n\n# Build all dependencies\ncargo build --release\n\n# Run servers (in separate terminals)\ncargo run --bin wicked-waifus-config-server\ncargo run --bin wicked-waifus-login-server\ncargo run --bin wicked-waifus-gateway-server\ncargo run --bin wicked-waifus-game-server\n```\n\n##### Option B: Docker setup (Easier for beginners)\n\nIf you prefer a containerized setup, you can use Docker:\n\n```sh\n# Clone the repository\ngit clone --recursive https://github.com/FosterG4/wicked-waifus-rs.git\ncd wicked-waifus-rs\n\n# Pull LFS files\ngit lfs pull\n\n# Build Docker images\n# On Windows:\nbuilder.bat\n# On Linux/macOS:\n./builder.sh\n\n# Start all services\ndocker compose up -d\n\n# Check service status\ndocker compose ps\n```\n\n##### Option C: Using pre-built binaries\n\nNavigate to the [Releases](https://git.xeondev.com/wickedwaifus/wicked-waifus-rs/releases) page and download the latest release for your platform.\n\nLaunch all servers in separate terminals:\n```sh\n./wicked-waifus-config-server\n./wicked-waifus-login-server\n./wicked-waifus-gateway-server\n./wicked-waifus-game-server\n```\n\n**Note**: You don't need to install Rust and Protoc if using pre-built binaries, though building from sources is preferred for better compatibility and customization.\n\n#### Configuration\n\nEach server creates its own configuration file in the current working directory upon first startup. You'll need to configure these files with your specific settings.\n\n##### Database Configuration\n\nConfigure PostgreSQL credentials in each server's config file:\n\n```toml\n[database]\nhost = \"localhost:5432\"\nuser_name = \"postgres\"\npassword = \"your_password\"\ndb_name = \"wicked_waifus_db\"\n```\n\n**Important**: Make sure to create the database `wicked_waifus_db` before starting the servers. You can do this using PgAdmin or the command line.\n\n##### Server Configuration Files\n\nThe following configuration files will be created in your working directory:\n- `configserver.toml` - Configuration server settings\n- `loginserver.toml` - Login server settings  \n- `gateway.toml` - Gateway server settings\n- `gameserver.toml` - Game server settings\n\n#### Data Files\n\nThe repository includes necessary data files managed by Git LFS:\n- Logic JSON collections (`data/assets/game-data/BinData`)\n- Config/hotpatch indexes (`data/assets/config-server`, `data/assets/hotpatch-server`)\n\n**Important**: Large files are managed by Git LFS. After cloning, run `git lfs pull` to download all large files.\n\n#### Client Setup\n\nTo connect to your server:\n\n1. Download Wuthering Waves Beta 2.1 client\n2. Apply the [wicked-waifus-win-patch](https://git.xeondev.com/wickedwaifus/wicked-waifus-win-patch/releases)\n3. Add necessary `.pak` files from [wicked-waifus-pak](https://git.xeondev.com/wickedwaifus/wicked-waifus-pak)\n\n#### Development Tools\n\nThis fork includes additional development tools:\n\n- **Database Manager**: `db-manager.ps1` - PowerShell script for database management\n- **Environment Example**: `.env.example` - Template for environment variables\n- **Cursor Rules**: `.cursor/rules/` - Development guidelines and project structure\n\n### Troubleshooting\n\n- **Build Issues**: Ensure you have the latest Rust toolchain and all dependencies installed\n- **Database Connection**: Verify PostgreSQL is running and credentials are correct\n- **Port Conflicts**: Check that required ports are not in use by other applications\n- **LFS Issues**: Run `git lfs pull` if large files are missing\n- **Environment Variables**: Ensure `.env` file is properly configured\n- **For additional help**: [Visit the original project's Discord](https://discord.gg/reversedrooms)\n\n### Support\n\nThis is a community fork. For official support and updates, please visit the [original repository](https://git.xeondev.com/wickedwaifus/wicked-waifus-rs).\n\nIf you want to support the original project, feel free to [send a tip via boosty](https://boosty.to/xeondev/donate)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffosterg4%2Fwicked-waifus-rs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffosterg4%2Fwicked-waifus-rs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffosterg4%2Fwicked-waifus-rs/lists"}