diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..eb64e2f --- /dev/null +++ b/.editorconfig @@ -0,0 +1,8 @@ +[*] +charset = utf-8 +indent_style = space +indent_size = 4 +tab_width = 4 +insert_final_newline = true +trim_trailing_whitespace = true +max_line_length = 80 diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..823b0b0 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,62 @@ +## AUTO-DETECT +## Handle line endings automatically for files detected as +## text and leave all files detected as binary untouched. +## This will handle all files NOT defined below. +* text=auto eol=lf + +# Text +*.conf +*.conf.dist +*.txt +*.md +*.cmake + +# Bash +*.sh text + +# Lua if lua module? +*.lua + +# SQL +*.sql + +# C++ +*.c text +*.cc text +*.cxx text +*.cpp text +*.c++ text +*.hpp text +*.h text +*.h++ text +*.hh text + + +## For documentation + +# Documents +*.doc diff=astextplain +*.DOC diff=astextplain +*.docx diff=astextplain +*.DOCX diff=astextplain +*.dot diff=astextplain +*.DOT diff=astextplain +*.pdf diff=astextplain +*.PDF diff=astextplain +*.rtf diff=astextplain +*.RTF diff=astextplain + + +# Graphics +*.png binary +*.jpg binary +*.jpeg binary +*.gif binary +*.tif binary +*.tiff binary +*.ico binary +# SVG treated as an asset (binary) by default. If you want to treat it as text, +# comment-out the following line and uncomment the line after. +*.svg binary +#*.svg text +*.eps binary diff --git a/.gitignore b/.gitignore index d011fdd..6080e59 100644 --- a/.gitignore +++ b/.gitignore @@ -46,3 +46,4 @@ local.properties .loadpath .project .cproject +.vscode/c_cpp_properties.json diff --git a/README.md b/README.md index 2ec7a54..13f92b6 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,38 @@ -# mod-individual-XP +# Individual XP Module -Allows players to set their own XP rate. +Allows players to _View, Set, or Toggle_ the rate at which they gain experience individually. # How to install 1) clone this module into the modules directory of the main source 2) apply the provided sql in the character database -3) rerun cmake +3) re-run cmake 4) compile. +# Config + +There are two variables to configure in the Config: +1) Max XP Rate +2) Default XP Rate + +The Max XP Rate variable dictates how high a player can set their XP rate.
+While the Default XP Rate variable dictates what XP rate players start with and the rate will be set to if the user does '.XP Default' + +# Player Commands + +| Command | Description | +|-------------|---------------------------------------------------| +| .XP | Main Module Command | +| .XP View | Displays the current XP rate | +| .XP Set # | Changes the XP rate to the value specified | +| .XP Default | Returns the XP rate to the default value | +| .XP Disable | Disables all XP gain until user does '.XP Enable' | +| .XP Enable | Enables all XP gain if it was disabled | + +# Video Showcase + +[![Youtube Link](https://i.imgur.com/Jhrdgv6.png)](https://www.youtube.com/watch?v=T6UEX47mPeE) # Show your appreciation + [![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=SBJFTAJKUNEXC) diff --git a/sql/auth/.gitkeep b/sql/auth/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/sql/characters/.gitkeep b/sql/characters/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/sql/character/IndivisualXP.sql b/sql/characters/IndividualXP.sql similarity index 100% rename from sql/character/IndivisualXP.sql rename to sql/characters/IndividualXP.sql diff --git a/sql/world/.gitkeep b/sql/world/.gitkeep new file mode 100644 index 0000000..e69de29