Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
249 changes: 249 additions & 0 deletions docs/DOCUMENTATION_README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,249 @@
# ReanimateMC Documentation Website

Welcome to the ReanimateMC documentation! This is a comprehensive, multilingual documentation website for the ReanimateMC Minecraft plugin.

## ๐ŸŒ Viewing the Documentation

### Online (GitHub Pages)

Once deployed with GitHub Pages, the documentation will be available at:
```
https://matissead.github.io/ReanimateMC/
```

### Locally

To view the documentation locally:

1. Clone the repository
2. Navigate to the `docs` directory
3. Open `index.html` in your web browser
4. Or use a local server:
```bash
cd docs
python3 -m http.server 8000
# Then visit http://localhost:8000
```

## ๐Ÿ“š Documentation Structure

### Main Pages (English)

- **index.html** - Homepage with plugin overview and features
- **commands.html** - Complete commands reference
- **permissions.html** - Detailed permissions documentation
- **configuration.html** - Configuration guide with all settings
- **npc-system.html** - NPC summon system documentation
- **api.html** - Developer API documentation

### Language Directories

- **fr/** - French translations (Complete example provided)
- **es/** - Spanish translations (To be added)
- **de/** - German translations (To be added)
- **it/** - Italian translations (To be added)
- **ru/** - Russian translations (To be added)
- **zh/** - Chinese translations (To be added)
- **kr/** - Korean translations (To be added)
- **pt/** - Portuguese translations (To be added)

### Assets

- **assets/css/style.css** - Modern, responsive stylesheet
- **assets/js/main.js** - JavaScript for language switching and interactivity

## ๐ŸŽจ Features

### Design & UI

- โœ… Modern, clean design with gradient accents
- โœ… Fully responsive (mobile, tablet, desktop)
- โœ… Dark navbar with primary color scheme
- โœ… Card-based layout for features
- โœ… Beautiful hero section with stats
- โœ… Smooth animations and transitions
- โœ… Font Awesome icons throughout
- โœ… Syntax-highlighted code blocks

### Functionality

- โœ… Language switcher in navigation
- โœ… Smooth scrolling navigation
- โœ… Back-to-top button
- โœ… Copy code blocks on click
- โœ… Responsive navigation menu
- โœ… Comprehensive linking between pages

### Content Coverage

- โœ… Complete command reference with examples
- โœ… Detailed permissions documentation
- โœ… Full configuration guide
- โœ… NPC system comprehensive docs
- โœ… Developer API with code examples
- โœ… LuckPerms setup examples
- โœ… Integration patterns and best practices

## ๐ŸŒ Supported Languages

Currently implemented:
- ๐Ÿ‡ฌ๐Ÿ‡ง **English** (en) - Complete โœ…
- ๐Ÿ‡ซ๐Ÿ‡ท **French** (fr) - Example complete โœ…

Planned/Template Ready:
- ๐Ÿ‡ช๐Ÿ‡ธ Spanish (es)
- ๐Ÿ‡ฉ๐Ÿ‡ช German (de)
- ๐Ÿ‡ฎ๐Ÿ‡น Italian (it)
- ๐Ÿ‡ท๐Ÿ‡บ Russian (ru)
- ๐Ÿ‡จ๐Ÿ‡ณ Chinese (zh)
- ๐Ÿ‡ฐ๐Ÿ‡ท Korean (kr)
- ๐Ÿ‡ต๐Ÿ‡น Portuguese (pt)

See [TRANSLATION_GUIDE.md](TRANSLATION_GUIDE.md) for how to add new translations.

## ๐Ÿ“– Documentation Sections

### 1. Commands
- All plugin commands with detailed descriptions
- Usage examples for each command
- Permission requirements
- Administrative, player, NPC, and utility commands
- Command aliases

### 2. Permissions
- Complete permission list
- Default values for each permission
- Permission group examples
- LuckPerms configuration examples
- NPC system permissions
- Best practices for permission setup

### 3. Configuration
- All config.yml settings explained
- Default values and descriptions
- Configuration tips by server type
- NPC system configuration
- Performance optimization tips

### 4. NPC System
- Three NPC types: Golem, Healer, Protector
- How to summon and use NPCs
- NPC behavior and AI
- Requirements and restrictions
- Configuration options
- Use cases and scenarios

### 5. Developer API
- Getting started guide
- Maven/Gradle dependency setup
- Event API (PlayerKOEvent, PlayerReanimatedEvent)
- KOManager API methods
- Integration examples
- Best practices for developers

## ๐Ÿš€ Deployment

### GitHub Pages

To deploy the documentation with GitHub Pages:

1. Go to repository Settings
2. Navigate to Pages section
3. Select source: Deploy from branch
4. Select branch: main (or your branch)
5. Select folder: /docs
6. Save

The documentation will be live at:
```
https://[username].github.io/[repository]/
```

### Custom Domain

To use a custom domain:

1. Add a `CNAME` file in the docs directory with your domain
2. Configure DNS records at your domain provider
3. Enable HTTPS in GitHub Pages settings

## ๐Ÿ”ง Customization

### Colors

Main colors are defined in CSS variables in `assets/css/style.css`:

```css
:root {
--primary-color: #e74c3c; /* Red */
--secondary-color: #3498db; /* Blue */
--dark-color: #2c3e50; /* Dark gray */
--success-color: #27ae60; /* Green */
/* ... */
}
```

### Logo

To add a custom logo:
1. Add logo image to `assets/images/`
2. Update `.nav-brand` in HTML files
3. Adjust CSS if needed

### Content

To update content:
1. Edit the HTML files directly
2. Maintain the existing structure
3. Test changes locally before committing
4. Update translations accordingly

## ๐Ÿ“ Contributing

### Adding Content

1. Update the relevant HTML file
2. Test locally
3. Update translations if needed
4. Submit a pull request

### Adding Translations

1. Follow the [TRANSLATION_GUIDE.md](TRANSLATION_GUIDE.md)
2. Create language directory
3. Translate all pages
4. Test language switching
5. Submit a pull request

### Reporting Issues

- Typos or errors: Open an issue
- Missing translations: Open an issue or contribute
- Suggestions: Open a discussion or issue

## ๐Ÿ”— Links

- **Plugin Repository**: https://github.com/MatisseAD/ReanimateMC
- **Issues**: https://github.com/MatisseAD/ReanimateMC/issues
- **Releases**: https://github.com/MatisseAD/ReanimateMC/releases

## ๐Ÿ“„ License

The documentation follows the same license as the plugin itself. See the main repository LICENSE file.

## ๐Ÿ‘ค Author

**Jachou**

- GitHub: [@MatisseAD](https://github.com/MatisseAD)
- Plugin: ReanimateMC

## ๐Ÿ™ Credits

- **Icons**: Font Awesome
- **Design**: Custom CSS with modern web standards
- **Hosting**: GitHub Pages

---

**Need help?** Open an issue on the GitHub repository or check the plugin documentation at the main README.md
59 changes: 59 additions & 0 deletions docs/INDEX.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# ReanimateMC Documentation Index

## Quick Links

- ๐Ÿ  [Homepage](index.html) - Plugin overview and features
- ๐Ÿ’ป [Commands](commands.html) - Complete command reference
- ๐Ÿ”’ [Permissions](permissions.html) - Permission system guide
- โš™๏ธ [Configuration](configuration.html) - Configuration options
- ๐Ÿค– [NPC System](npc-system.html) - NPC summon documentation
- ๐Ÿ”ง [Developer API](api.html) - API for plugin developers

## Language Versions

- ๐Ÿ‡ฌ๐Ÿ‡ง [English](index.html) (Complete)
- ๐Ÿ‡ซ๐Ÿ‡ท [Franรงais](fr/index.html) (Example available)
- ๐Ÿ‡ช๐Ÿ‡ธ [Espaรฑol](es/) (Template ready)
- ๐Ÿ‡ฉ๐Ÿ‡ช [Deutsch](de/) (Template ready)
- ๐Ÿ‡ฎ๐Ÿ‡น [Italiano](it/) (Template ready)
- ๐Ÿ‡ท๐Ÿ‡บ [ะ ัƒััะบะธะน](ru/) (Template ready)
- ๐Ÿ‡จ๐Ÿ‡ณ [ไธญๆ–‡](zh/) (Template ready)
- ๐Ÿ‡ฐ๐Ÿ‡ท [ํ•œ๊ตญ์–ด](kr/) (Template ready)
- ๐Ÿ‡ต๐Ÿ‡น [Portuguรชs](pt/) (Template ready)

## Documentation Guides

- ๐Ÿ“– [Documentation README](DOCUMENTATION_README.md) - How to use this documentation
- ๐ŸŒ [Translation Guide](TRANSLATION_GUIDE.md) - How to contribute translations

## For Administrators

1. Start with [Homepage](index.html) for overview
2. Read [Quick Start](index.html#quick-start) for installation
3. Check [Commands](commands.html) for available commands
4. Configure [Permissions](permissions.html) for your server
5. Customize [Configuration](configuration.html) to your needs

## For Players

1. Learn about [gameplay mechanics](index.html#gameplay)
2. Understand [how it works](index.html#gameplay)
3. See [compatibility](index.html#compatibility) requirements

## For Developers

1. Review [API Documentation](api.html)
2. Check [integration examples](api.html#integration-examples)
3. Follow [best practices](api.html#best-practices)

## Need Help?

- ๐Ÿ› [Report Issues](https://github.com/MatisseAD/ReanimateMC/issues)
- ๐Ÿ“ฅ [Download Plugin](https://github.com/MatisseAD/ReanimateMC/releases)
- ๐Ÿ’ฌ [GitHub Discussions](https://github.com/MatisseAD/ReanimateMC/discussions)

---

**Version:** 1.2.02
**Last Updated:** 2024-10-21
**Minecraft:** 1.20.1+
Loading