Skip to content

Commit f9e1df6

Browse files
committed
fix: update documentation links and improve installation requirements
1 parent 86d5819 commit f9e1df6

10 files changed

Lines changed: 42 additions & 41 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
[![Spigot](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/compact/available/spigot_vector.svg)](https://www.spigotmc.org/resources/120743/)
77
[![Hangar](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/compact/available/hangar_vector.svg)](https://hangar.papermc.io/Nighter/SmartSpawner)
88

9-
[![Documentation](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/compact/documentation/ghpages_vector.svg)](https://nighterdevelopment.github.io/smartspawner-docs/)
9+
[![Documentation](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/compact/documentation/ghpages_vector.svg)](https://nighterdevelopment.github.io/SmartSpawner/)
1010
[![discord-plural](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/compact/social/discord-plural_46h.png)](http://discord.com/invite/FJN7hJKPyb)
1111

1212
</div>
@@ -30,7 +30,7 @@
3030

3131
## API
3232

33-
For developers interested in integrating with SmartSpawner, visit our [Developer API Documentation](https://nighterdevelopment.github.io/smartspawner-docs/developer-api/api-installation/) for installation instructions and documentation.
33+
For developers interested in integrating with SmartSpawner, visit our [Developer API Documentation](https://nighterdevelopment.github.io/SmartSpawner/developer-api/api-installation/) for installation instructions and documentation.
3434

3535
## Building
3636

core/src/main/resources/item_spawners_settings.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Important: Each time a spawner is triggered, it will generate between min_mobs and max_mobs (default: 1 to 4) times the drops specified below.
22
# For detailed configuration guide and examples, please visit:
3-
# https://nighterdevelopment.github.io/smartspawner-docs/item_spawners_settings/
3+
# https://nighterdevelopment.github.io/SmartSpawner/item_spawners_settings/
44

55
# Default head material for unknown items
66
default_material: "SPAWNER"

core/src/main/resources/paper-plugin.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ main: github.nighter.smartspawner.SmartSpawner
44
api-version: '1.21'
55
description: "A GUI-based spawner plugin that generates items and experience without spawning mobs"
66
authors: [ https://github.com/NighterDevelopment/SmartSpawner ]
7-
website: "https://nighterdevelopment.github.io/smartspawner-docs/"
7+
website: "https://nighterdevelopment.github.io/SmartSpawner/"
88
folia-supported: true
99

1010
# Load order - POSTWORLD means after all worlds are loaded

core/src/main/resources/spawners_settings.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Important: Each time a spawner is triggered, it will generate between min_mobs and max_mobs (default: 1 to 4) times the drops specified below.
22
# For detailed configuration guide and examples, please visit:
3-
# https://nighterdevelopment.github.io/smartspawner-docs/spawners_settings/
3+
# https://nighterdevelopment.github.io/SmartSpawner/spawners_settings/
44

55
# Default head material for unknown mobs
66
default_material: "SPAWNER"

docs/README.md

Lines changed: 22 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@
77

88
This repository hosts the official documentation website for **[SmartSpawner](https://modrinth.com/plugin/smart-spawner-plugin)**, a powerful Minecraft plugin designed to enhance mob spawner management on servers.
99

10+
> **Note:** The documentation source is located in the `docs/` folder of the main [SmartSpawner repository](https://github.com/NighterDevelopment/SmartSpawner).
11+
1012
## About SmartSpawner
1113

1214
SmartSpawner is a feature-rich plugin that simplifies and enhances the management of mob spawners in Minecraft servers. It offers advanced customization options, seamless integrations with popular plugins, and a robust developer API for extending functionality. Notably, its GUI-based system generates mob drops and experience without spawning entities, significantly boosting server performance.
@@ -31,8 +33,8 @@ SmartSpawner is a feature-rich plugin that simplifies and enhances the managemen
3133

3234
1. **Clone the repository**:
3335
```bash
34-
git clone https://github.com/NighterDevelopment/smartspawner-docs.git
35-
cd smartspawner-docs
36+
git clone https://github.com/NighterDevelopment/SmartSpawner.git
37+
cd SmartSpawner/docs
3638
```
3739

3840
2. **Install dependencies**:
@@ -61,18 +63,21 @@ SmartSpawner is a feature-rich plugin that simplifies and enhances the managemen
6163
## Project Structure
6264

6365
```
64-
smartspawner-docs/
65-
├── src/
66-
│ ├── content/
67-
│ │ ├── docs/ # Main documentation files (Markdown/MDX)
68-
│ │ └── config.ts # Content configuration
69-
│ ├── components/ # Custom Astro components
70-
│ ├── styles/ # Custom CSS styles
71-
│ └── assets/ # Static assets
72-
├── public/ # Public static files
73-
├── astro.config.mjs # Astro configuration
74-
├── package.json # Project dependencies and scripts
75-
└── tsconfig.json # TypeScript configuration
66+
SmartSpawner/
67+
├── docs/ # Documentation site (this folder)
68+
│ ├── src/
69+
│ │ ├── content/
70+
│ │ │ └── docs/ # Main documentation files (Markdown/MDX)
71+
│ │ ├── components/ # Custom Astro components
72+
│ │ ├── styles/ # Custom CSS styles
73+
│ │ └── assets/ # Static assets
74+
│ ├── public/ # Public static files
75+
│ ├── astro.config.mjs # Astro configuration
76+
│ ├── package.json # Project dependencies and scripts
77+
│ └── tsconfig.json # TypeScript configuration
78+
├── core/ # Plugin core module
79+
├── api/ # Plugin API module
80+
└── ... # Other plugin source files
7681
```
7782

7883
## Contributing
@@ -113,21 +118,17 @@ For significant changes or new features, please open an issue first to discuss t
113118

114119
## Deployment
115120

116-
This site is configured for deployment to GitHub Pages:
117-
118-
```bash
119-
npm run deploy
120-
```
121+
The site is automatically deployed to GitHub Pages via GitHub Actions on every push to the `main` branch. The workflow is defined in `.github/workflows/deploy-docs.yml` at the root of the repository.
121122

122-
This command builds the site and deploys it using `gh-pages`.
123+
The live site is available at: https://nighterdevelopment.github.io/SmartSpawner/
123124

124125
## License
125126

126127
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
127128

128129
## Support and Contact
129130

130-
- **Issues**: Report bugs or request features via [GitHub Issues](https://github.com/NighterDevelopment/smartspawner-docs/issues)
131+
- **Issues**: Report bugs or request features via [GitHub Issues](https://github.com/NighterDevelopment/SmartSpawner/issues)
131132
- **Discussions**: Join community discussions on [Discord Server](https://dsc.gg/nighterdevelopment)
132133

133134
For questions about the SmartSpawner plugin itself, please refer to the main plugin repository or community channels.

docs/package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "smartspawner-docs",
2+
"name": "smartspawner",
33
"type": "module",
44
"version": "0.0.1",
55
"scripts": {

docs/src/content/docs/index.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ hero:
99
file: ../../assets/Spawner.png
1010
actions:
1111
- text: Get Started
12-
link: /smartspawner-docs/installation/
12+
link: /SmartSpawner/installation/
1313
icon: rocket
1414
variant: primary
1515
- text: View Features
16-
link: /smartspawner-docs/features/
16+
link: /SmartSpawner/features/
1717
icon: star
1818
variant: minimal
1919
- text: Download
@@ -31,22 +31,22 @@ import ContributorList from '/src/components/ContributorList.astro';
3131
<CardGrid stagger>
3232
<Card title="Installation" icon="rocket">
3333
Install SmartSpawner plugin on your Minecraft server.<br />
34-
[Get Started →](/smartspawner-docs/installation/)
34+
[Get Started →](/SmartSpawner/installation/)
3535
</Card>
3636

3737
<Card title="Features" icon="star">
3838
Experience advanced mechanics with spawner stacking and a powerful, user-friendly GUI.<br />
39-
[Learn More →](/smartspawner-docs/features/)
39+
[Learn More →](/SmartSpawner/features/)
4040
</Card>
4141

4242
<Card title="Commands" icon="laptop">
4343
Browse the complete command list and permission system.<br />
44-
[View Reference →](/smartspawner-docs/commands/)
44+
[View Reference →](/SmartSpawner/commands/)
4545
</Card>
4646

4747
<Card title="API Integration" icon="puzzle">
4848
Extend SmartSpawner with your own plugins using the flexible developer API.<br />
49-
[Developer Docs →](/smartspawner-docs/developer-api/)
49+
[Developer Docs →](/SmartSpawner/developer-api/)
5050
</Card>
5151
</CardGrid>
5252

docs/src/content/docs/installation.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Before installing SmartSpawner, ensure your server meets these requirements:
99

1010
| Requirement | Specification |
1111
|-------------|---------------|
12-
| **Minecraft Version** | 1.21 - 1.21.10 |
12+
| **Minecraft Version** | 1.21 - 1.21.11 |
1313
| **Server Software** | [Paper](https://papermc.io/downloads/paper), [Folia](https://papermc.io/downloads/folia), [Purpur](https://purpurmc.org/) or compatible forks |
1414
| **Java Version** | Java 21+ (latest LTS recommended) |
1515

@@ -74,11 +74,11 @@ If you encounter issues:
7474

7575
1. **Check console logs** for error messages
7676
2. **Join our Discord** for community support: [Discord](https://discord.gg/zrnyG4CuuT)
77-
3. **Report bugs** on GitHub: [Issues](https://github.com/ptthanh02/SmartSpawner/issues)
77+
3. **Report bugs** on GitHub: [Issues](https://github.com/NighterDevelopment/SmartSpawner/issues)
7878

7979
<br>
8080
<br>
8181

8282
---
8383

84-
*Last update: November 9, 2025 18:53:43*
84+
*Last update: March 12, 2026 15:53:43*

docs/src/content/docs/plugin-compatibility.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ SmartSpawner respects all major protection plugins to ensure proper permissions
2929
- **[GriefPrevention](https://modrinth.com/plugin/griefprevention)**
3030
- **[Lands](https://www.spigotmc.org/resources/lands-%E2%AD%95-land-claim-plugin-%E2%9C%85-grief-prevention-protection-gui-management-nations-wars-1-21-support.53313/)**
3131
- **[Towny Advanced](https://www.spigotmc.org/resources/towny-advanced.72694/)**
32-
- **[SimpleClaimSystem](https://modrinth.com/plugin/simpleclaimsystem)** - **[📖 Setup Guide](/SmartSpawner-Docs/integrations/SimpleClaimSystem)**
32+
- **[SimpleClaimSystem](https://modrinth.com/plugin/simpleclaimsystem)** - **[📖 Setup Guide](/SmartSpawner/integrations/simpleclaimsystem)**
3333
- **[RedProtect](https://www.spigotmc.org/resources/redprotect-anti-grief-server-protection-region-management-mod-mobs-flag-compat-1-7-1-21.15841/)**
3434
- **[Residence](https://www.spigotmc.org/resources/residence-1-7-10-up-to-1-21.11480/)**
3535
- **[MinePlots](https://builtbybit.com/resources/mineplots.21646/)**
@@ -44,7 +44,7 @@ Multi-world compatibility ensures spawners work across different worlds:
4444
## SkyBlock Integrations
4545
Specialized support for skyblock environments with enhanced features:
4646

47-
- **[SuperiorSkyblock2](https://www.spigotmc.org/resources/%E2%9A%A1%EF%B8%8F-superiorskyblock2-%E2%9A%A1%EF%B8%8F-the-best-core-on-market-%E2%9A%A1%EF%B8%8F-1-21-3-support.87411/)** -> **[📖 Setup Guide](/SmartSpawner-Docs/integrations/superiorskyblock2)**
47+
- **[SuperiorSkyblock2](https://www.spigotmc.org/resources/%E2%9A%A1%EF%B8%8F-superiorskyblock2-%E2%9A%A1%EF%B8%8F-the-best-core-on-market-%E2%9A%A1%EF%B8%8F-1-21-3-support.87411/)** -> **[📖 Setup Guide](/SmartSpawner/integrations/superiorskyblock2)**
4848
- **[IridiumSkyblock](https://www.spigotmc.org/resources/iridium-skyblock-1-13-1-21-5.62480/)**
4949

5050
## RPG & Skills Systems
@@ -53,7 +53,7 @@ Specialized support for skyblock environments with enhanced features:
5353

5454
## Custom Mob Systems
5555

56-
- **[MythicMobs](https://www.spigotmc.org/resources/mythicmobs.5702/)** -> **[📖 Setup Guide](/SmartSpawner-Docs/integrations/mythicmobs)**
56+
- **[MythicMobs](https://www.spigotmc.org/resources/mythicmobs.5702/)** -> **[📖 Setup Guide](/SmartSpawner/integrations/mythicmobs)**
5757

5858
## Additional Compatibility
5959

0 commit comments

Comments
 (0)