Cleaned up Storage Database documentation (#4521)

* Adjusted documentation to match standard. * Removed double quote from Table as there are no special characters used for these. * Added license to import file.
rathena · Jan 13, 2020 · 3142863 · 3142863
1 parent 939761a
commit 3142863
Show file tree

Hide file tree

Showing 2 changed files with 48 additions and 22 deletions.
diff --git a/conf/import-tmpl/inter_server.yml b/conf/import-tmpl/inter_server.yml
@@ -1,21 +1,43 @@
-# Config for Storages
+# This file is a part of rAthena.
+#   Copyright(C) 2017 rAthena Development Team
+#   https://rathena.org - https://github.com/rathena
 #
-# To access the premium storage, use script command 'openstorage2'.
+# This program is free software: you can redistribute it and/or modify
-# If premium storages are added, copy the structure of the storage table and match the table name in this config.
+# it under the terms of the GNU General Public License as published by
-# The 'max' of premium storages are not adjusted by 'vip_storage_increase' config nor MIN_STORAGE.
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+#
+##########################################################################
+# Storage Database
+##########################################################################
 #
-# Structure:
+# Storage Settings
-#	- ID: <storage_id>          // (int) Storage ID will be used for script command 'openstorage2'.
+#
-#	  Name: "<storage name>"    // (string) Storage name will be sent to the client to display on the title bar.
+##########################################################################
-#	  Table: "<storage_table>"  // (string) Name of table where storage is saved. The table stucture is the same as the default storage table.
+#	- ID                       Storage ID.
-#	  Max: <max_amount>         // (int) *optional* Maximum number of items in storage. MAX_STORAGE will be used if no value is defined.
+#	  Name                     Storage name that will be sent to the client to display on the title bar.
-###############################################################################################################################################
+#	  Table                    Name of SQL table where storage is saved. The table structure is the same as the default storage table.
+#	  Max                      Maximum number of items. (Default: MAX_STORAGE)
+###########################################################################
+# To access the premium storage, use script command 'openstorage2'.
+# If more premium storages are added, copy the structure of the storage table and match the table name in this config.
+# The 'Max' of premium storages are not adjusted by 'vip_storage_increase' config nor MIN_STORAGE.
+###########################################################################
+
 Header:
   Type: INTER_SERVER_DB
   Version: 1
 
 #Body:
 #   - ID: 1
 #     Name: "VIP Storage"
-#     Table: "vip_storage"
+#     Table: vip_storage
 #     Max: 300
diff --git a/conf/inter_server.yml b/conf/inter_server.yml
@@ -15,18 +15,22 @@
 # You should have received a copy of the GNU General Public License
 # along with this program. If not, see <http://www.gnu.org/licenses/>.
 #
-###########################################################################
+##########################################################################
-# Config for Storages
+# Storage Database
+##########################################################################
 #
-# To access the premium storage, use script command 'openstorage2'.
+# Storage Settings
-# If premium storages are added, copy the structure of the storage table and match the table name in this config.
-# The 'max' of premium storages are not adjusted by 'vip_storage_increase' config nor MIN_STORAGE.
 #
-# Structure:
+##########################################################################
-#	- ID: <storage_id>          // (int) Storage ID will be used for script command 'openstorage2'.
+#	- ID                       Storage ID.
-#	  Name: "<storage name>"    // (string) Storage name will be sent to the client to display on the title bar.
+#	  Name                     Storage name that will be sent to the client to display on the title bar.
-#	  Table: "<storage_table>"  // (string) Name of table where storage is saved. The table stucture is the same as the default storage table.
+#	  Table                    Name of SQL table where storage is saved. The table structure is the same as the default storage table.
-#	  Max: <max_amount>         // (int) *optional* Maximum number of items in storage. MAX_STORAGE will be used if no value is defined.
+#	  Max                      Maximum number of items. (Default: MAX_STORAGE)
+###########################################################################
+# To access the premium storage, use script command 'openstorage2'.
+# If more premium storages are added, copy the structure of the storage table and match the table name in this config.
+# The 'Max' of premium storages are not adjusted by 'vip_storage_increase' config nor MIN_STORAGE.
+###########################################################################
 
 Header:
   Type: INTER_SERVER_DB
@@ -35,7 +39,7 @@ Header:
 Body:
   - ID: 0
     Name: "Storage"
-    Table: "storage"
+    Table: storage
 
 Footer:
   Imports: