Initial commit

gamemodes/darkrp/HELP/Avoid editing core files.txt

@@ -0,0 +1,35 @@
+Avoid editing DarkRP core files AT ALL COST!
+DarkRP files are not meant for you to be edited, not even the config folder.
+
+Anything in DarkRP should be changeable without having to change core DarkRP files.
+If this isn't possible, it should be MADE possible.
+
+Open an issue on GitHub if there is no
+- DarkRP function that allows you to change DarkRP the way you want:
+	https://darkrp.miraheze.org/wiki/Category:Functions
+- DarkRP Hook that allows you to change DarkRP the way you want:
+	https://darkrp.miraheze.org/wiki/Category:Hooks
+
+--[[---------------------------------------------------------------------------
+            How to configure
+---------------------------------------------------------------------------]]
+Download https://github.com/FPtje/DarkRPModification as an addon and use the
+config folder inside it to configure DarkRP.
+
+--[[---------------------------------------------------------------------------
+            How to modify DarkRP without modifying the core files
+---------------------------------------------------------------------------]]
+1. Go to darkrpmodification/lua/darkrp_modules
+2. Make a folder with any name, e.g. mydarkrpmod
+	it has to be lowercase
+	no spaces or weird characters
+3. go into mydarkrpmod
+4. if you're doing a serverside thing, make a Lua file that starts with sv_
+		e.g. sv_init.lua
+	if you're doing a clientside thing, make a Lua file that starts with cl_
+		e.g. cl_init.lua
+	if you're doing a shared thing, make a Lua file that starts with sh_
+		e.g. sh_init.lua
+
+	if you don't know what serverside/clientside/shared is, you should probably not be trying to modify DarkRP.
+5. Use the DarkRP functions and hooks (and other functions/hooks) to make your thing

gamemodes/darkrp/HELP/DarkRP wiki.txt

@@ -0,0 +1,4 @@
+The official DarkRP wiki can be found at
+https://darkrp.miraheze.org/wiki/Main_Page
+
+You can find out how to make custom jobs, shipments and many other things there!

gamemodes/darkrp/HELP/How to install.txt

@@ -0,0 +1,5 @@
+Put the darkrp folder in garrysmod/gamemodes
+
+IF YOU PUT DARKRP IN ADDONS IT WON'T WORK!
+
+REMOVE OLD DARKRP FOLDER BEFORE PUTTING THE NEW ONE IN

gamemodes/darkrp/HELP/Problem in DarkRP.txt

@@ -0,0 +1,70 @@
+--[[---------------------------------------------------------------------------
+What to do when you have a problem in DarkRP
+---------------------------------------------------------------------------]]
+
+There are three kinds of problems that can happen in DarkRP:
+- The problem caused by the end user (think of a bad modification or a bad setting)
+- The problem caused by a mod for DarkRP (think of a weapon pack, model pack or extra money printers or things like that)
+- The problem caused by the developer of DarkRP
+
+The very first step of solving your problem is figuring out who caused it. Often this is easy to figure out. If DarkRP started to error
+when you edited your HUD, it's probably your fault (or the server host's). If the server starts in sandbox, or if you get the error
+"couldn't include file darkrp\gamemode\cl_init.lua (File not found)"
+it's your fault.
+
+When a weapon from a weapon pack does crazy things, it's probably the person who made that weapon pack.
+When the problem occurs with unedited DarkRP features, it might be DarkRP's fault.
+There are cases for which it might be difficult to determine who is responsible for the problem.
+In these cases you should look at the errors that usually show up. The errors usually say which mod caused the problem.
+
+If it's your fault, blame yourself. If you caused a problem you don't know how to solve, you have two options:
+1. ask on a forum or ask your friends for help. If you contact mod developers,
+	they might get mad at you for being asked something they have nothing to do with
+2. undo the change that broke DarkRP. To do this, always make sure you have a backup
+
+If it's the fault of a third party mod developer, contact them to report the bug. They are the only ones who can (and are willing to)
+solve the problems caused by their mod.
+
+
+--[[---------------------------------------------------------------------------
+Reporting a bug for DarkRP
+---------------------------------------------------------------------------]]
+Only report bugs for issues of which you are VERY SURE that it is the fault of DarkRP developers.
+
+To report a bug for DarkRP, you need to follow very strict rules. These rules exist so the bugs can be easily identified and solved.
+
+The most important rules are:
+1. Do not ask for help. Your need of help is not the fault of DarkRP.
+2. Do not report an issue when you are unable to install DarkRP.
+3. Do not report problems that you caused yourself.
+4. Do not report problems for other mods.
+5. Do not report problems for a server that you do not own or develop for
+6. Do not report a problem that has been reported before (you can search on the bug reporting site)
+7. Do not repost your problem when your previous problem has been closed. You can post in a closed issue and you will still be listened to.
+8. Never just post "It doesn't work" that's no information to work on.
+
+Failure to abide by these rules will get your report closed and/or your account banned from reporting issues.
+
+How to report a bug:
+1. Enter lua_log_sv 1 in RCon or the server console
+2. Make the problem happen
+	if a weapon messes up when you shoot, shoot the weapon.
+	if it happens on server start, change level or restart the server
+	if it happens when the mayor tries to place a lawboard, make the mayor try to spawn a lawboard
+	etc.
+3. Go to the FTP of your server.
+4. In the garrysmod/ folder you should see "lua_errors_server.txt" and/or "clientside_errors.txt"
+ 	upload the contents of BOTH these files to www.pastebin.com
+ 	if you don't see those files, make sure you did everything right (lua_log_sv must be 1).
+ 	if you don't see the files and you're sure that you did the logging right, mention this in the bug report:
+ 	"No error log files were generated."
+ 	If you only see one file, upload that one file to www.pastebin.com and mention the following in the bug report:
+ 	"The other error log file was not generated."
+
+ 	Thanks. Errors help A LOT.
+5. Go to https://github.com/FPtje/DarkRP/issues/new (DON'T SKIP THE PREVIOUS STEPS)
+6. Think of an appropriate title. Try to be specific here
+7. Take the issue template from "github issue template.txt" and copy paste it into the "Write" field.
+8. Fill it in, try not to leave anything empty!
+	MORE information = MUCH HIGHER chance that the problem will be solved
+9. Click "Submit new issue"