Skip to content

Documentation

Simon_Flash edited this page Jan 14, 2018 · 5 revisions

ActiveTime - Developed by Simon_Flash (mcsimonflash@gmail.com)
Current Version: 1.3.2
Status: Active -> New features and updates are in development


Command List

/activetime: Opens the in-game documentation
/activetime check [User]: Checks the times of a user
/activetime leaderboard [Positions]: Displays the ActiveTime leaderboard
/activetime report [User] [Days]: Generates an ActiveTime report


Permission List

activetime.base: Gives access to /activetime (required for commands)
activetime.check.base: Gives access to check
->activetime.check.other: Allows check to be used on other users
activetime.leaderboard.base: Gives access to leaderboard
activetime.report.base: Gives access to report
activetime.log.base: Enables ActiveTime logging

The permission option playtime is also used for applying limits to players.


Nucleus Tokens

If Nucleus is installed, ActiveTime will enable the following tokens.

{{activetime}}: Replaced with the players activetime
{{afktime}}: Replace with the players afktime


Commands

ActiveTime

Usage: /activetime
Alias: activetime, atime
Permission: activetime.base

Gives access to /activetime. Running this command will display the in-game documentation for ActiveTime.

This permission is separate from logging active time and is used for commands. If you'd like to track a players time, they must have activetime.log.base


Check

Usage: /activetime check [user]
->user: optional name of the user (defaults to sender)
Aliases: check, time, /playtime, /ontime
Permission: activetime.check.base
->activetime.check.other allows Check to be used on other players

Displays the active time for yourself or the player specified. This command pulls directly from the storage file, and thus ignores the current cache.


DailyReport

Usage: /activetime dailyreport [date]
->days: date of the report (defaults to today)
Aliases: report, info
Permission: activetime.report.base

Generates an ActiveTime daily report for the given date based on the data within the date's log file. The date is expected to be in yyyy-mm-dd format, such as 2018-01-13, which correlates to the log file 2018-01-13.stor.


Leaderboard

Usage: /activetime leaderboard [positions]
->positions: optional number of positions (defaults to config setting)
Aliases: leaderboard, rank, top
Permission: activetime.leaderboard.base

Displays the ActiveTime leaderboard for the number of positions requested. The leaderboard is refreshed each time the in-game cache is saved (and thus might be slightly outdated) rather than being generated with each call of the command.


Report

Usage: /activetime report [user] [days]
->user: optional name of the user (defaults to sender)
->days: number of days to include in the report (defaults to show this month)
Aliases: report, info
Permission: activetime.report.base

Generates an ActiveTime report for the given user based on the user's data in available log files. Reports that request more days than available in the logs may have unexpected results.

Clone this wiki locally