summaryrefslogtreecommitdiffstats
path: root/MCServer/Plugins/APIDump/SettingUpDecoda.html
diff options
context:
space:
mode:
authorJulian Laubstein <julianlaubstein@yahoo.de>2015-08-13 10:19:24 +0200
committerJulian Laubstein <julianlaubstein@yahoo.de>2015-08-13 10:19:24 +0200
commit24e8edb19cc376223d4300c2ee3a92bea9d86c04 (patch)
tree462e41b1a76eb51f442cac3785adeb38afaef115 /MCServer/Plugins/APIDump/SettingUpDecoda.html
parentMerge pull request #2417 from mjhanninen/fix-clang-warnings (diff)
downloadcuberite-24e8edb19cc376223d4300c2ee3a92bea9d86c04.tar
cuberite-24e8edb19cc376223d4300c2ee3a92bea9d86c04.tar.gz
cuberite-24e8edb19cc376223d4300c2ee3a92bea9d86c04.tar.bz2
cuberite-24e8edb19cc376223d4300c2ee3a92bea9d86c04.tar.lz
cuberite-24e8edb19cc376223d4300c2ee3a92bea9d86c04.tar.xz
cuberite-24e8edb19cc376223d4300c2ee3a92bea9d86c04.tar.zst
cuberite-24e8edb19cc376223d4300c2ee3a92bea9d86c04.zip
Diffstat (limited to 'MCServer/Plugins/APIDump/SettingUpDecoda.html')
-rw-r--r--MCServer/Plugins/APIDump/SettingUpDecoda.html4
1 files changed, 2 insertions, 2 deletions
diff --git a/MCServer/Plugins/APIDump/SettingUpDecoda.html b/MCServer/Plugins/APIDump/SettingUpDecoda.html
index 7f51ad19d..8a74f0240 100644
--- a/MCServer/Plugins/APIDump/SettingUpDecoda.html
+++ b/MCServer/Plugins/APIDump/SettingUpDecoda.html
@@ -27,7 +27,7 @@
<p>To begin using Decoda, you need to create a project, or load an existing one. Decoda projects have a .deproj extension, and are simply a list of Lua files that are to be opened. You can create a project through menu Project -> New Project. Save your project first, so that Decoda knows what relative paths to use for the files. Then either add existing Lua files or create new one, through menu Project -> Add Add New File / Add Existing File.</p>
<p>Next you need to set up the executable that Decoda will run when debugging your files. Select menu Project -> Settings. A new dialog will open:<br />
<img src="Static/decoda_debug_settings.png" /></p>
- <p>In the debugging section, fill in the full path to MCServer.exe, or click the triple-dot button to browse for the file. Note that the Working directory will be automatically filled in for you with the folder where the executable is (until the last backslash). This is how it's supposed to work, don't change it; if it for some reason doesn't update, copy and paste the folder name from the Command edit box. All done, you can close this dialog now.</p>
+ <p>In the debugging section, fill in the full path to Cuberite.exe, or click the triple-dot button to browse for the file. Note that the Working directory will be automatically filled in for you with the folder where the executable is (until the last backslash). This is how it's supposed to work, don't change it; if it for some reason doesn't update, copy and paste the folder name from the Command edit box. All done, you can close this dialog now.</p>
<h2><img src="Static/decoda_logo.png" /> Debugging</h2>
<p>You are now ready to debug your code. Before doing that, though, don't forget to save your project file. If you haven't done so already, enable your plugin in the settings.ini file. If you want the program to break at a certain line, it is best to set the breakpoint before starting the program. Set the cursor on the line and hit F9 (or use menu Debug -> Toggle Breakpoint) to toggle a breakpoint on that line. Finally, hit F5, or select menu Debug -> Start to launch Cuberite under the debugger. The Cuberite window comes up and loads your plugin. If Decoda displays the Project Settings dialog instead, you haven't set up the executable to run, see the Project management section for instructions.</p>
@@ -39,7 +39,7 @@
<p>So far everything seems wonderful. Unfortunately, it doesn't always go as easy. There are several limits to what Decoda can do:</p>
<ul>
<li>When the program encounters a logical bug (using a nil value, calling a non-existent function etc.), Decoda will break, but usually the Watch window and the tooltips are showing nonsense values. You shouldn't trust them in such a case, if you kep running into such a problem regularly, put console logging functions (LOG) in the code to print out any info you need prior to the failure.</li>
- <li>Sometimes breakpoints just don't work. This is especially true if there are multiple plugins that have files of the same name. Breakpoints will never work after changing the code and reloading the plugin in MCServer; you need to stop the server and start again to reenable breakpoints.</li>
+ <li>Sometimes breakpoints just don't work. This is especially true if there are multiple plugins that have files of the same name. Breakpoints will never work after changing the code and reloading the plugin in Cuberite; you need to stop the server and start again to reenable breakpoints.</li>
<li>Most weirdly, sometimes Decoda reports an error, but instead of opening the current version of the file, opens up another window with old contents of the file. Watch for this, because you could overwrite your new code if you saved this file over your newer file. Fortunately enough, Decoda will always ask you for a filename before saving such a file.</li>
<li>Decoda stores the project in two files. The .deproj file has the file list, and should be put into version control systems. The .deuser file has the settings (debugged application etc.) and is per-user specific. This file shouldn't go to version control systems, because each user may have different paths for the debuggee.</li>
<li>Unfortunately for us Windows users, the Decoda project file uses Unix-lineends (CR only). This makes it problematic when checking the file into a version control system, since those usually expect windows (CRLF) lineends; I personally convert the lineends each time I edit the project file using <a href="http://jsimlo.sk/notepad/">TED Notepad</a>.</li>