-
-
Notifications
You must be signed in to change notification settings - Fork 40
Installation
Currently, Carbon supports two different setups:
- Carbon is installed on one or more backends (but not the proxy)
- For 2+ servers a messaging service is used to communicate (i.e. Redis), and external database storage must be used
- Carbon is installed on Velocity (but not the backends)
- Currently, only single-proxy setups are supported (multi-proxy support is planned)
Each setup has its pros and cons, but in general, option 1/installed on all backends is more fully featured and should be preferred when possible.
To install Carbon, all you need to do is drop the plugin into your server's plugins (or mods) folder, and start the server. The rest of the file creation will be handled by the plugin the first time you start it.
Setting up Carbon is fairly simple. For the basics, you go into the configuration file and edit the default settings to have the attributes you desire it to have. Then you edit the default channel the way you'd like, and add however many more channels you want. Finally, you set up Permissions so that your users can use the plugin as needed.
Most of the settings in the default configuration are intended as examples, and it is encouraged that you modify them in order to achieve your desired chat format. Contexts, which are options included in the config, are disabled by default, though they can be also easily be modified to match your desired specifications.
For Carbon to start up, you need LuckPerms. This is in order to retrieve groups, prefixes, and other essential formatting from a competent permissions plugin (See Luckperms).
- Paper 1.19.4+
- Fabric 1.20.1
- Velocity 3.2.0+
Sponge API 11 (1.20.1)
Sponge module is awaiting updates.