Welcome to the zombs.io Wiki repository! Here are some things you should know before contributing to the project.
- Giving credits for others must be done if the content is not made by yourself.
- Noting yourself as the writer for your pages is recommended (but not a requirement).
- Writer / Credits notes should be at the end of a page.
Usage of AI agents to write documentation is permitted (and in fact, encouraged to speed up writing). This project provides an AGENTS.md to help your AI agents write more accurately without / with minor modifications afterwards.
- Some knowledge of Markdown (.md) files
- Basic understanding of GitHub (making pull requests, resolving merge conflicts, etc.)
- GitHub Desktop is recommended to make
gitactions more friendly.
Click the "Fork" button right next to the "Star" button. (and you should also star this repo while you're at it, thank you :))
Use git on your machine to clone your fork.
- Markdown files for each page (adjacent to their actual route) are placed inside
/src, and static assets are placed inside/src/public(see Website layout). - If you are writing a new page, make sure to also change the configuration in
.vitepress/config.mts.
pnpm run docs:dev- Navigate to the link provided by the command above to see the preview website.
Commit your edits to your fork, then go to your fork on GitHub and open a new pull request.
- Add badges to indicate classes being "public" or "private" while documenting the engine, if possible (use
type: tipfor public,type: dangerfor private). - Keep the formatting consistent (check
AGENTS.mdfor a more systematic format guideline).
Here are some markdown extensions that you can use to make your pages look even more perfect.
| Head1 | Head2 | ... |
| :--- | :--- | :--- |
| data1 | data2 | ... |
| ... | ... | ... |You may want to use these containers when addressing a property in detail, etc.
::: info
This is an info box.
:::
::: tip
This is a tip.
:::
::: warning
This is a warning.
:::
::: danger
This is a dangerous warning.
:::
::: details
This is a details block.
:::You may want to use these badges when necessary.
### Title <Badge type="info" text="info" />
### Title <Badge type="tip" text="tip" />
### Title <Badge type="warning" text="warning" />
### Title <Badge type="danger" text="danger" />
src/
├── architecture
│ ├── engine
│ │ ├── main
│ │ │ ├── input
│ │ │ │ ├── inputManager.md
│ │ │ │ ├── inputPacketCreator.md
│ │ │ │ └── inputPacketScheduler.md
│ │ │ ├── network
│ │ │ │ ├── mbf
│ │ │ │ │ ├── in_depth.md
│ │ │ │ │ ├── Module.md
│ │ │ │ │ ├── overview.md
│ │ │ │ │ └── v6_overview.md
│ │ │ │ ├── BinCodec.md
│ │ │ │ └── network.md
│ │ │ ├── renderer
│ │ │ │ ├── entity_models
│ │ │ │ │ ├── ArrowTowerModel.md
│ │ │ │ │ ├── BombTowerModel.md
│ │ │ │ │ ├── CannonTowerModel.md
│ │ │ │ │ ├── CharacterModel.md
│ │ │ │ │ ├── DoorModel.md
│ │ │ │ │ ├── ExperienceBar.md
│ │ │ │ │ ├── GoldMineModel.md
│ │ │ │ │ ├── GoldStashModel.md
│ │ │ │ │ ├── HarvesterModel.md
│ │ │ │ │ ├── HealthBar.md
│ │ │ │ │ ├── HealTowersSpellModel.md
│ │ │ │ │ ├── MageTowerModel.md
│ │ │ │ │ ├── MeleeTowerModel.md
│ │ │ │ │ ├── PathNodeModel.md
│ │ │ │ │ ├── PlacementIndicatorModel.md
│ │ │ │ │ ├── PlayerModel.md
│ │ │ │ │ ├── RangeIndicatorModel.md
│ │ │ │ │ ├── ShieldBar.md
│ │ │ │ │ ├── SlowTrapModel.md
│ │ │ │ │ ├── TowerModel.md
│ │ │ │ │ ├── WallModel.md
│ │ │ │ │ ├── ZombieBossModel.md
│ │ │ │ │ ├── ZombieModel.md
│ │ │ │ │ └── ZombieRangedModel.md
│ │ │ │ ├── entity_types
│ │ │ │ │ ├── DrawEntity.md
│ │ │ │ │ ├── Entity.md
│ │ │ │ │ ├── GroundEntity.md
│ │ │ │ │ ├── ModelEntity.md
│ │ │ │ │ ├── NetworkEntity.md
│ │ │ │ │ ├── SpriteEntity.md
│ │ │ │ │ └── TextEntity.md
│ │ │ │ └── renderer.md
│ │ │ ├── ui
│ │ │ │ ├── components
│ │ │ │ │ ├── UiAnnouncementOverlay.md
│ │ │ │ │ ├── UiBuffBar.md
│ │ │ │ │ ├── UiBuildingOverlay.md
│ │ │ │ │ ├── UiChat.md
│ │ │ │ │ ├── UiComponent.md
│ │ │ │ │ ├── UiDayNightOverlay.md
│ │ │ │ │ ├── UiDayNightTicker.md
│ │ │ │ │ ├── UiHealthBar.md
│ │ │ │ │ ├── UiIntro.md
│ │ │ │ │ ├── UiLeaderboard.md
│ │ │ │ │ ├── UiMap.md
│ │ │ │ │ ├── UiMenuIcons.md
│ │ │ │ │ ├── UiMenuParty.md
│ │ │ │ │ ├── UiMenuSettings.md
│ │ │ │ │ ├── UiMenuShop.md
│ │ │ │ │ ├── UiPartyIcons.md
│ │ │ │ │ ├── UiPipOverlay.md
│ │ │ │ │ ├── UiPlacementOverlay.md
│ │ │ │ │ ├── UiPopupOverlay.md
│ │ │ │ │ ├── UiPrerollAd.md
│ │ │ │ │ ├── UiReconnect.md
│ │ │ │ │ ├── UiResources.md
│ │ │ │ │ ├── UiRespawn.md
│ │ │ │ │ ├── UiShieldBar.md
│ │ │ │ │ ├── UiShopHatItem.md
│ │ │ │ │ ├── UiShopItem.md
│ │ │ │ │ ├── UiShopPetItem.md
│ │ │ │ │ ├── UiSpellIcons.md
│ │ │ │ │ ├── UiSpellOverlay.md
│ │ │ │ │ ├── UiToolbar.md
│ │ │ │ │ ├── UiToolbarBuilding.md
│ │ │ │ │ ├── UiToolbarItem.md
│ │ │ │ │ ├── UiTooltip.md
│ │ │ │ │ └── UiWalkthrough.md
│ │ │ │ ├── styles.md
│ │ │ │ └── ui.md
│ │ │ └── world
│ │ │ ├── entityGrid.md
│ │ │ ├── localPlayer.md
│ │ │ ├── replicator.md
│ │ │ └── world.md
│ │ ├── utils
│ │ │ ├── assetManager.md
│ │ │ ├── debug.md
│ │ │ ├── metrics.md
│ │ │ ├── platform.md
│ │ │ └── util.md
│ │ ├── data_interfaces.md
│ │ ├── game.md
│ │ ├── overview.md
│ │ └── schema.md
│ └── exploit
│ ├── active
│ │ └── downgrade.md
│ ├── inactive
│ │ ├── global_chat.md
│ │ ├── pet_olympics.md
│ │ └── skill_point.md
│ └── overview.md
├── community
│ ├── records.md
│ └── terms.md
├── gameplay
│ ├── bugs
│ │ ├── active
│ │ │ ├── minor_bugs.md
│ │ │ ├── odd_zombie_spawn.md
│ │ │ ├── out_the_map.md
│ │ │ └── rss_go_poof.md
│ │ ├── inactive
│ │ │ ├── blank_wave.md
│ │ │ ├── carl_healing.md
│ │ │ ├── minor_bugs.md
│ │ │ ├── token_healing.md
│ │ │ ├── tower_buff.md
│ │ │ ├── tower_heal.md
│ │ │ ├── tower_nerf.md
│ │ │ ├── undying_zombs.md
│ │ │ └── woody_invincibility.md
│ │ └── overview.md
│ ├── game
│ │ ├── buildings
│ │ │ ├── arrow_tower.md
│ │ │ ├── bomb_tower.md
│ │ │ ├── buildings.md
│ │ │ ├── cannon_tower.md
│ │ │ ├── door.md
│ │ │ ├── gold_mine.md
│ │ │ ├── gold_stash.md
│ │ │ ├── harvester.md
│ │ │ ├── mage_tower.md
│ │ │ ├── melee_tower.md
│ │ │ ├── slow_trap.md
│ │ │ └── wall.md
│ │ ├── entities
│ │ │ ├── entities_overview.md
│ │ │ ├── neutral.md
│ │ │ ├── player.md
│ │ │ └── zombies.md
│ │ ├── changelog.md
│ │ └── introduction.md
│ └── scripts
│ ├── fundamentals
│ │ ├── dc_triggers.md
│ │ └── overview.md
│ ├── popular_scripts
│ │ ├── overview.md
│ │ └── xera.md
│ └── overview.md
└── index.md
src/public/
├── asset
│ ├── architecture
│ │ ├── engine
│ │ │ ├── main
│ │ │ │ └── network
│ │ │ │ ├── BinCodec
│ │ │ │ │ ├── attributeMaps.json
│ │ │ │ │ └── rpcMaps.json
│ │ │ │ └── mbf
│ │ │ │ └── overview
│ │ │ │ ├── error_1.png
│ │ │ │ └── mbf.jpg
│ │ │ ├── overview
│ │ │ │ └── game.png
│ │ │ ├── schema
│ │ │ │ ├── buildings.json
│ │ │ │ ├── entities.json
│ │ │ │ ├── items.json
│ │ │ │ └── spells.json
│ │ │ └── utils
│ │ │ └── assetManager
│ │ │ └── files.json
│ │ └── exploit
│ │ └── inactive
│ │ └── skill_point
│ │ ├── jeremy_1.png
│ │ └── jeremy_2.png
│ └── gameplay
│ ├── bugs
│ │ ├── active
│ │ │ ├── odd_zombie_spawn
│ │ │ │ ├── weird_spawn_again.png
│ │ │ │ └── weird_spawn.png
│ │ │ └── rss_go_poof
│ │ │ ├── rock.png
│ │ │ └── spotinfo.png
│ │ └── inactive
│ │ ├── blank_wave
│ │ │ └── no_zombs.png
│ │ ├── carl_healing
│ │ │ ├── healing_carl_2.png
│ │ │ └── healing_carl.png
│ │ ├── minor_bugs
│ │ │ └── harvester_overflow.png
│ │ ├── tower_buff
│ │ │ ├── buffed_corner.png
│ │ │ ├── buffed_env.png
│ │ │ ├── deathscore.png
│ │ │ ├── deathwave.png
│ │ │ ├── erokscore.png
│ │ │ ├── lowspw.png
│ │ │ ├── newbie.png
│ │ │ ├── tower_buff_proj.png
│ │ │ └── woodybuff.png
│ │ ├── tower_heal
│ │ │ ├── t1033_heal.png
│ │ │ └── t9_heal.png
│ │ └── undying_zombs
│ │ ├── 4_colours.png
│ │ ├── boss.png
│ │ ├── graph1.png
│ │ ├── graph2.png
│ │ ├── nohp.png
│ │ ├── undead_pile.png
│ │ └── zombies.png
│ ├── game
│ │ ├── buildings
│ │ │ ├── building_bar.png
│ │ │ └── mage.png
│ │ ├── entities
│ │ │ ├── npc_behaviour.png
│ │ │ ├── npc_raid.png
│ │ │ ├── npcs.png
│ │ │ └── zombieswstats.png
│ │ └── introduction
│ │ ├── homepage.png
│ │ ├── party1.png
│ │ ├── party2.png
│ │ └── ui.png
│ └── scripts
│ └── popular_scripts
│ └── xera
│ └── intro.png
├── cover.png
├── logo.svg
└── robots.txt