DOCSEARCHbyAlgolia
Submit Docs

Lumina Collection Documentation

website·Indexed 31 days ago

https://docs.luminacollection.net

Documentation for the Lumina Collection of plugins, including Rollbound, a pen-and-paper style dice rolling plugin, and Nameshift, a plugin for renaming users with stylized nicknames.

Tokens
2.9K
Snippets
18
Records
28
Agent score
50%

What's inside Lumina Collection

  1. Overview of Nameshift plugin

    Nameshift is a plugin within the Lumina Collection designed for name management. It enables players to change their own names or the names of others using stylized nicknames.

  2. Overview of Rollbound dice plugin

    Rollbound is a plugin within the Lumina Collection designed for dice-related functionality. It enables players to roll dice in a manner consistent with traditional pen-and-paper tabletop games.

  4. Roll multiple dice and modifiers using roll strings

    Rollbound supports 'roll strings' to handle complex rolls. Use a dot (.) to separate different sets of dice and plus (+) or minus (-) signs for modifiers. The format follows [number]d[sides]. For example, 2d6+1 rolls two six-sided dice and adds 1 to the total.
    2d6+1       # Two 6-sided dice plus 1
2d20.5d6-1  # Two 20-sided dice and five 6-sided dice minus 1

  6. Update Nameshift to a newer version

    To update Nameshift, replace the existing Nameshift jar file in the plugins folder with the new version and restart the server. Check the requirements to determine if the new version of Nameshift also requires an update to the AxiosAPI plugin.

  7. Localize Rollbound messages using Properties files

    Rollbound uses .properties files located in the plugins/Rollbound/i18n folder for localization. It supports MiniMessage formatting for colors and styles.

    • Default Localizations: Found in the default folder. These are reset on every server restart and should not be edited directly. English and German are supported by default.
    • Custom Localizations: Found in the custom folder. Files here take priority over defaults. To customize messages, create a file in the custom folder (e.g., custom.properties). You only need to include the specific keys you wish to override.
    # Example: Overriding a specific key in plugins/Rollbound/i18n/custom/custom.properties
command.proll.meta.argument.threshold=target value

  9. Create language-specific custom translations

    To create a custom translation for a specific language, copy the corresponding default localization file and rename it to custom_<language>.properties inside the plugins/Rollbound/i18n/custom folder. For example, to customize German translations, use custom_de.properties.

  10. Download and update Rollbound

    Rollbound is available on Modrinth and GitHub. Modrinth is the recommended source because it contains all releases (e.g., 1.0.1), whereas GitHub typically only contains major releases (e.g., 1.0).

    To update Rollbound:

    1. Replace the existing Rollbound jar file with the new version.
    2. Restart the server.
    3. Check if a new version of Axios is required and update it if necessary.

  11. Install Nameshift on a Paper server

    Nameshift requires the AxiosAPI plugin to function. To install Nameshift, download both the AxiosAPI and Nameshift jar files from Modrinth and place them in the server's plugins folder. After placing the files, start or restart the server. Note: Using /reload is not supported and will not work for this installation.

  12. Install Rollbound on a Paper server

    To install Rollbound, you must have a Paper server and the AxiosAPI plugin installed.

    1. Download the required version of Axios from Modrinth.
    2. Download the desired version of Rollbound from Modrinth.
    3. Place both jar files in the server's plugins folder.
    4. Start or restart the server.

    Warning: Do not use the /reload command, as it is not supported and will not work for this plugin.