Setting up your Service / Business
Just like with the community, you will need a Discord server in which you have the Administrator permission.
Services live inside communities, therefore if you do not already have set up a community, you will need to do that first by following the community setup guide.
To create a new service, follow these steps:
Create a new service
- Login to OnClock with your Discord account.
- Select your community.
- Click on the "Add my service" button.
Set up service details
- Set a name for your service. (e.g. "Police Department", "Fire & EMS", "Pharmacy", "Roger's Taxi Company", etc.)
- Select an icon.
It will be displayed when running the/onclock
command. - Select a time limit.
This limits the time that a user can be on-duty. Helpful if the users often forget to set themselves off-duty at the end of their shifts. You can set it to 0 to disable it. - Click on "Next" to proceed.
Configure the Discord server
- Choose one of the options below:
- Use the community's Discord server.
It will use the same server as your community, but the bot needs to have been added previously when setting up your community. - Use a custom Discord server.
It will use a different, or the same, Discord server as your community and you will have the chance to invite the bot.WARNING
Do not change the default permissions for the bot. By default, we only request the necessary ones.
- Use the community's Discord server.
- Click on "Next" to proceed.
- Choose one of the options below:
Configure the Discord Integration
- Select a text channel to use for running the Discord commands (e.g.
/onduty
,/offduty
,/onclock
, etc). The bot will only be able to process commands from this channel. - Optionally, select a Discord role to be given to users who are on-duty.
- Click on the "Discord Server Level Configuration" to open the collapsed section.
- Read carefully the instructions displayed, you will need to perform those actions manually in your Discord server. This is a limitation of Discord. The instructions are also available here: Discord Server Manual Configurations
- Click on "Save" to confirm the creation of the service.
- Select a text channel to use for running the Discord commands (e.g.
Final steps
- Click on your service.
- Open the "Misc Settings", located on the left navigation bar under the "Admin" section.
- Click on "Admin Roles" to open that section.
- Add all the roles that your admin staff have access to. It will allow them to access the admin settings of the service.
- Click on "Shown Services" to open that section.
- Add all the other services you want to see when running a
/onclock
command.
Great, you are now ready to start using OnClock!