forked from adamdburton/pointshop-documentation
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Spellings and fixes to heading links
- Loading branch information
1 parent
405bccc
commit c3714ea
Showing
21 changed files
with
119 additions
and
113 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,18 +1,18 @@ | ||
###<a name="download"></a>Download | ||
###<a href="#download" name="download">Download</a> | ||
|
||
The recommend method of obtaining PointShop is by downloading the [archive](https://github.com/adamdburton/pointshop/archive/master.zip) from [GitHub](https://github.com/adamdburton/pointshop). You can also [clone the repository](https://github.com/adamdburton/pointshop) if you're used to using the command line. | ||
|
||
PointShop is not currently available on the Steam Workshop because of the dynamic nature of items. | ||
|
||
###<a name="installation"></a>Installation | ||
###<a href="#installation" name="installation">Installation</a> | ||
|
||
1. Download and unzip the [archive](https://github.com/adamdburton/pointshop/archive/master.zip) or [clone the repository](https://github.com/adamdburton/pointshop) into your addons folder. | ||
2. Restart your server or change the map. | ||
|
||
###<a name="configuration"></a>Configuration | ||
###<a href="#configuration" name="configuration">Configuration</a> | ||
|
||
See the [configuration](/configuration) page for more information on each configuration option. | ||
|
||
###<a name="customization"></a>Customization | ||
###<a href="#customization" name="customization">Customization</a> | ||
|
||
To create new items and categories for PointShop, see the [items](/items) and [categories](/categories) pages. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,23 +1,23 @@ | ||
<p class="lead">Data providers give PointShop flexibilty on where data for each players Points and Items are stored. By Default, PointShop uses the PData provider by default.</p> | ||
<p class="lead">Data providers give PointShop flexibility on where data for each players Points and Items are stored. By Default, PointShop uses the PData provider.</p> | ||
|
||
####<a name="pdata"></a>PData | ||
####<a href="#pdata" name="pdata">PData</a> | ||
|
||
This provider uses the built in [Player.GetPData](http://wiki.garrysmod.com/page/Player/GetPData) and [Player.SetPData](http://wiki.garrysmod.com/page/Player/SetPData) functions. Data from these functions is stored in the sv.db file on the server. | ||
|
||
<p class="info"><i class="fa fa-info-circle"></i> The sv.db file can be transferred between servers. This will keep all Point and Item data for players.</p> | ||
|
||
PS.Config.DataProvider = 'pdata' | ||
|
||
####<a name="data"></a>Data | ||
####<a href="#data" name="data">Data</a> | ||
|
||
This provider uses text files in the `garrysmod/data/pointshop` folder. Each player is given their own file in this folder and their data is stored in [JSON](http://en.wikipedia.org/wiki/JSON) format. | ||
|
||
<p class="info"><i class="fa fa-info-circle"></i> The PointShop folder can be transferred between servers. This will keep all Point and Item data for players.</p> | ||
<p class="info"><i class="fa fa-info-circle"></i> The garrysmod/data/pointshop folder can be transferred between servers. This will keep all Point and Item data for players.</p> | ||
|
||
PS.Config.DataProvider = 'data' | ||
|
||
####<a name="mysql"></a>MySQL | ||
####<a href="#mysql" name="mysql">MySQL</a> | ||
|
||
The MySQL provider is available as a separate download from the [pointshop-mysql](https://github.com/adamdburton/pointshop-mysql) github repository. This provider connects to a MySQL server and supports synchronizing Points and Items between servers. | ||
The MySQL provider is available as a separate download from the [pointshop-mysql](https://github.com/adamdburton/pointshop-mysql) GitHub repository. This provider connects to a MySQL server and supports synchronizing Points and Items between servers. | ||
|
||
PS.Config.DataProvider = 'mysql' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,11 @@ | ||
<p class="lead">The following properties are set automatically by PointShop when items are loaded.</p> | ||
|
||
####<a name="name"></a>ITEM.ID | ||
####<a href="#name" name="name">ITEM.ID</a> | ||
|
||
**Type:** <span class="type">String</span> | ||
**Description:** The same as the filename for the item. | ||
|
||
####<a name="name"></a>ITEM.Category | ||
####<a href="#name" name="name">ITEM.Category</a> | ||
|
||
**Type:** <span class="type">String</span> | ||
**Description:** The name of the category the item belongs to. |
Oops, something went wrong.