Skip to content

Commit c52e4dc

Browse files
committed
feat: expand ServiceIO documentation with comprehensive features and benefits
1 parent 982a1fb commit c52e4dc

File tree

1 file changed

+103
-1
lines changed

1 file changed

+103
-1
lines changed

content/docs/serviceio/index.mdx

Lines changed: 103 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,106 @@ description: A vault drop-in replacement with a new and modern api
44
icon: BookMarked
55
---
66

7-
Coming soon!
7+
ServiceIO is a powerful, modern replacement for Vault that provides a comprehensive service layer for Minecraft servers.
8+
It offers the traditional Vault API and the VaultUnlocked API while extending functionality far beyond what Vault provides.
9+
10+
**100% Vault and VaultUnlocked compatibility**, just remove the Vault plugin and drop in ServiceIO.
11+
12+
## What is ServiceIO?
13+
14+
ServiceIO is designed as a drop-in replacement for Vault, but with significantly more features and a cleaner, more modern API.
15+
While Vault focuses primarily on economy services, ServiceIO provides unified interfaces for:
16+
17+
- **Economy Services** - Balance management, transactions, and banking
18+
- **Permission Services** - Groups and permissions
19+
- **NPC Services** - NPC management
20+
- **Hologram Services** - Unified hologram API
21+
- **Chat Services** - Chat formatting and prefixes/suffixes
22+
- **Service Conversion** - Convert data between different service providers
23+
24+
## Key Features
25+
26+
### Service Provider Flexibility
27+
28+
ServiceIO allows you to switch between different service providers (like economy or permission plugins) without losing your data.
29+
The built-in conversion system lets you migrate from one plugin to another seamlessly.
30+
While Vault offers the same functionality for economy services, ServiceIO makes it possible for all services.
31+
This allows you to switch from, lets say, GroupManager to LuckPerms in a breeze, or from Citizens to FancyNPCs.
32+
33+
34+
### Full Compatibility
35+
- **Vault API** - Complete drop-in replacement
36+
- **VaultUnlocked API** - Modern async-capable alternative
37+
- **Paper & Folia** - Optimized for modern server software
38+
- **PlaceholderAPI** - Extensive placeholder support
39+
40+
## Supported Services
41+
42+
### Economy
43+
- Balance management (per-world support)
44+
- Banking systems
45+
- Currency formatting
46+
- Multi-language support
47+
- Support for multiple currencies
48+
49+
### Permissions
50+
- Group management
51+
- Permission assignment
52+
- Prefix/suffix handling
53+
- Inheritance systems
54+
- World-specific permissions
55+
56+
### NPC Management
57+
- Unified NPC API
58+
- Event handling
59+
60+
### Holograms
61+
- Unified Hologram API
62+
- Dynamic content updates
63+
64+
## How does ServiceIO Work?
65+
66+
ServiceIO uses a wrapper-based architecture that creates a bridge between different service APIs:
67+
68+
```mermaid
69+
graph TD;
70+
subgraph AA [Plugins]
71+
A[Vault plugin];
72+
B[ServiceIO plugin];
73+
C[VaultUnlocked plugin];
74+
end
75+
subgraph BB [Wrapped Services]
76+
E[Vault];
77+
F[ServiceIO];
78+
G[VaultUnlocked];
79+
end
80+
Z[ServiceIO];
81+
A --> Z;
82+
B --> Z;
83+
C --> Z;
84+
Z --> E;
85+
Z --> F;
86+
Z --> G;
87+
```
88+
89+
This design allows:
90+
- **Multi-directional Compatibility** - Vault plugins work with modern services and vice versa
91+
- **Service Abstraction** - Switch providers without changing your plugins
92+
- **Enhanced Features** - Access advanced features through the ServiceIO API
93+
94+
## Why Choose ServiceIO?
95+
96+
### For Server Administrators
97+
- **Easy Migration** - Convert between different plugins effortlessly
98+
- **Better Performance** - Optimized for modern server software
99+
- **Comprehensive Support** - Handles economy, permissions, NPCs, and more
100+
101+
### For Developers
102+
- **Clean APIs** - Modern, well-documented interfaces
103+
- **Future-Proof** - Built for current and upcoming Minecraft versions
104+
- **Type Safety** - Better IDE support and fewer runtime errors
105+
106+
### For Players
107+
- **Seamless Experience** - All your favorite plugins work together
108+
- **Data Preservation** - Never lose progress during plugin changes
109+
- **Better Performance** - Faster responses and reduced lag

0 commit comments

Comments
 (0)