Skip to content

Update README with new module sections #55

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
NB-Core merged 1 commit into from
Sep 18, 2025
Merged

Update README with new module sections #55

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,13 @@ Directories group modules by purpose:

- **pvp/** – player versus player extensions and events
- **administrative/** – tools for admins and moderation
- **commentary/** – enhancements for chat and roleplay areas
- **forest/** – general forest related tweaks
- **forest_specials/** – additional forest encounters and bosses
- **inventory/** - inventory and items
- **general/** – cross-area features and utilities
- **inventory/** - inventory and items
- **lodge/** – lodge upgrades
- **mail/** – player mail quality-of-life tools
- **mounts/** – mount related features
- **systems/** – large feature systems (races, specialties etc.)
- **village_modules/** – village shops and activities
Expand All @@ -39,6 +42,10 @@ Below is a short description for every module. Some modules rely on others; depe
- **suspendannounce** – announce server suspensions.
- **welcomemail** – send welcome e‑mail to new users.

### Commentary
- **gm_rp_talk** – lets game masters participate in fzone roleplay chats without breaking character tools.
- **sectionedchats** – splits village, superuser, and clan chat areas into RP and OOC channels with unread indicators.

### Dwellings
- **dwcastles** - Castle type for dwellings core
- **dwcityhouses** - City House type for dwellings core
Expand Down Expand Up @@ -71,6 +78,9 @@ Below is a short description for every module. Some modules rely on others; depe
- **wedgieman** – the fearsome Wedgie Man.
- **zombie** – zombie outbreak event.

### General
- **mightyblogs** – public blogging system that lets authorised users post long-form updates accessible from the village, cemetery, and index. Older releases had serious issues; upgrade servers to at least version 1.1.

### inventory
- **inventory** - the entire updated item system by XChrisX for run with +nb core
- **findloot** – hooks `battle-victory` to roll for loot items via the inventory system (`items/findloot.php`).
Expand All @@ -81,6 +91,11 @@ Below is a short description for every module. Some modules rely on others; depe
- **lodgenonexpiration** – purchase non‑expiration account upgrade.
- **namechange** – allow players to change character name.

### Mail
- **mailarchive** – archive incoming messages into user-defined categories for long-term storage.
- **mailnotepad** – provides personal notepad fields inside the mail interface.
- **outbox** – review or optionally mirror sent messages, with support for a full separate outbox.

### Mounts
- **mount_feeder** – forest event where a mysterious vendor sells mount feed (requires `inventory`).
- **mountname** – Hunter's Lodge service letting players give mounts custom names.
Expand Down