Skip to content

docs: overhaul website and rename repo references to HypixelRecreation - #885

Merged
Swofty-Developments merged 14 commits into
Swofty-Developments:masterfrom
deyoyk:website-update
Aug 16, 2026
Merged

docs: overhaul website and rename repo references to HypixelRecreation#885
Swofty-Developments merged 14 commits into
Swofty-Developments:masterfrom
deyoyk:website-update

Conversation

@deyoyk

@deyoyk deyoyk commented Aug 16, 2026

Copy link
Copy Markdown
Contributor

updating website to hypixel recreation from hypixel skyblock

The shipped configuration/config.yml, the installer's generated config and the Settings defaults in commons all set via-version to false. The example config and three documentation pages claimed true, which pushed new operators onto a code path the project warns may cause issues of any kind.
There is no users collection and no profiles collection in MongoDB; accounts and profiles are bootstrapped in Redis by SwoftyData under the hsb:acct and hsb:prof prefixes, and ProfilesDatabase.connect is a no-op. ServiceAPI's actual third collection is api-request-counts, used by ApiRateLimiterHandler.
… reference

Both docker-compose.yml and the installer's compose generator run every service from the game_server_prepared image; there is no service_prepared image. The generator also derives container names by lowercasing the JAR name with the Service prefix stripped, so the auction house container is service_auctionhouse rather than service_auction.
The site title, the landing page hero and the opening sentence of the introduction all called the project bare Hypixel, which reads as the commercial network rather than this recreation of it. The rest of the PR already uses HypixelRecreation everywhere else.
…at work

Rank is held on the Redis account document at hsb:acct:players:<uuid> in the hypixel:rank field, so editing a MongoDB profile has never granted staff. The installer promotes players through a Lua script run against redis-cli behind the dashboard's Make player STAFF action, and RankCommand exposes /rank and /setrank in game for anyone who already holds STAFF.
configlib resolves overrides with the HYPIXEL_ prefix set in ConfigProvider, so MONGODB_URI and REDIS_URI have never done anything. The prefix is joined to the key path with an underscore and upper-cased, which leaves a double underscore after HYPIXEL and keeps the dashes from the kebab-case key names. API_PORT was never a config field either; APIService only reads a --port= command line flag.
The tree still described a layout with per-world directories under configuration/ and a skyblock/islands folder. Worlds are single .polar files in configuration/world/, the collections folder is plural, and each minigame keeps its maps in its own top-level folder. This brings the reference in line with the tree the setup guide already documents correctly, and renames the PicoLimbo heading to match the server.toml the section itself points at.
There are no profiles or users collections; both live in Redis behind SwoftyData. Added the collections that are actually opened somewhere in the codebase and were missing from the table: attribute, bedwars_stat_events, the three ravengard collections and api-request-counts.
The MongoDB URI setting is named mongodb in Settings, not mongodb-uri. The data saving section also pointed at a Swofty Velocity fork; Dockerfile.proxy pulls the stock PaperMC velocity-3.5.0-SNAPSHOT-605 build from fill-data.papermc.io, which is what this PR's proxy setup page already documents.
The root LICENSE is the GNU Affero General Public License v3.0, not MIT. Only the anticheat directory carries a permissive MIT licence, so the footer's blanket MIT claim was wrong for every other part of the project.
There is no System Check screen. The screen list in the TUI model has a dependency screen, the basics and selection screens, a summary and the run and dashboard screens, and CheckDependenciesReport only looks for docker, compose v2, a reachable daemon, git and curl. The only RAM figure anywhere is the estimate the summary screen derives from the server and service counts, so the row now describes that instead of a hardware validation that never happens.
…tor world

settings.gradle.kts includes proxy.api and pvp, neither of which appeared in the module table. TypeSkyWarsConfiguratorLoader.getMainInstance returns null, unlike its BedWars and Murder Mystery counterparts, so SKYWARS_CONFIGURATOR does not load hypixel_skywars_lobby.polar.
The page asked for 16 GB minimum and 24 GB recommended, which is more than the project ever asks for. The installer's own estimator budgets 900 MB plus 300 MB per server and 140 MB per service for the minimum, and 1500 plus 450 and 220 for the recommended figure, so even a full 28 server and 13 service install lands near 10.9 GB and 16.6 GB, and the default selection needs a few gigabytes. The port table also now lists the 20000 and upwards range the proxy assigns to game servers and PicoLimbo on 65535.
@Swofty-Developments
Swofty-Developments merged commit 243a12e into Swofty-Developments:master Aug 16, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants