-### Faster compiling and reloading of QuakeC
-
-You can use `QCCFLAGS_WERROR=""` to let the build succeed even with some warnings and `ZIP=:` to skip compressing the resulting csprogs.dat (client gamecode) into a pk3. A compressed csprogs.dat is only useful to increase download speed of such file if you host an online dedicated server.
-
-`QCCFLAGS_WERROR="" ZIP=: ./all compile`
-
-Server and menu code produce progs.dat and menu.dat respectively.
-
-Compiling the Xonotic game code without trying to compile the engine code reduces compile time a little bit, in the case you aren't interested in changing the engine code. You can do so by running this command from the xonotic-data.pk3dir directory:
-
-`make qc -j4`
-
-where `-j4` is an option that lets you use up to 4 CPU cores for the compilation (it's enabled by default in `./all compile`). If you want you can run `make all -j4` to enable csprogs.dat compression.
-
-To test the QC client and server programs you don't need to restart Xonotic, you just have to start a new game with `map <mapname>` (depending on how you launch Xonotic you may need to use `fs_rescan; map <mapname>`).
-
-To test the QC menu program, you just have to restart the menu by executing `menu_restart` in the console.
-
-### Debug prints
-
-Use `con_notify 4` together with `LOG_INFOF("my_var: %s", my_var);` (`%s` string, `%f` float, `%d` integer, `%v` vector) to see debug output without opening the console. Type `con_notify` and press `<TAB>` to see descriptions and more options (or use `apropos con_notify`).
-
-You can draw text anywhere on the map using `debug_text_3d(world_coords, message);` from `common/debug.qh`.
-
-### Multiple clients + clean config
-
-If you need 2 players for debugging, you can launch another client locally:
-- use -sessionid (e.g. `./all run -sessionid testing`) to keep your config
-- use -userdir (e.g. `./all run -userdir ~/.xonotic-testing +name tester +cl_allow_uid2name 0`) to get a clean config (if you delete the dir before each use)
- - you can set any cvar or run any command on start with `+cvar_name value`
- - `+name tester` avoids the nick selection dialog
- - `+cl_allow_uid2name 0` avoids an annoying popup
-
-### Testing with bots
-
-You can prevent bots from firing with `bot_nofire 1` or stop them completely with `bot_cmd * pause` (unstop them with `bot_cmd * continue`). With `sv_cheats 1` (takes effect next match), you can drag them around (default key V or 'drag object' in menu).
-
-Note that `sv_cheats 1` prevents bots from spawning in the campaign (should you decide to put it in your `autoexec.cfg` and later wonder why the campaign is broken).
-
-### Debugging
-
-Useful commands to debug qc code:
-```
-prvm_breakpoint : marks a statement or function as breakpoint (when this is executed, a stack trace is printed); to actually halt and investigate state, combine this with a gdb breakpoint on PRVM_Breakpoint, or with prvm_breakpointdump; run with just progs name to clear breakpoint
-
-prvm_edict : print all data about an entity number in the selected VM (server, client, menu)
-prvm_edictget : retrieves the value of a specified property of a specified entity in the selected VM (server, client menu) into a cvar or to the console
-prvm_edicts : prints all data about all entities in the selected VM (server, client, menu)
-prvm_edictset : changes value of a specified property of a specified entity in the selected VM (server, client, menu)
-prvm_edictwatchpoint : marks an entity field as watchpoint (when this is executed, a stack trace is printed); to actually halt and investigate state, combine this with a gdb breakpoint on PRVM_Breakpoint, or with prvm_breakpointdump; run with just progs name to clear watchpoint
-
-prvm_global : prints value of a specified global variable in the selected VM (server, client, menu)
-prvm_globalget : retrieves the value of a specified global variable in the selected VM (server, client menu) into a cvar or to the console
-prvm_globals : prints all global variables in the selected VM (server, client, menu)
-prvm_globalset : sets value of a specified global variable in the selected VM (server, client, menu)
-prvm_globalwatchpoint : marks a global as watchpoint (when this is executed, a stack trace is printed); to actually halt and investigate state, combine this with a gdb breakpoint on PRVM_Breakpoint, or with prvm_breakpointdump; run with just progs name to clear watchpoint
-```
-
-Examples:
-Print to console origin of entity number 1: `prvm_edictget server 1 origin`
-Save to a cvar origin of entity number 1: `prvm_edictget server 1 origin my_cvar`
-Set a custom origin for entity number 1: `prvm_edictset server 1 origin "100 200 0"`
-
-Setting view angles requires a particular trick, we also need to set fixangle to true in the same server frame:
-`prvm_edictset server 1 fixangle 1; prvm_edictset server 1 angles "20 -90 0"`
-
-Print to console vid_conheight client global: `prvm_edictget client vid_conheight`
-
-"Break" on statement: `prvm_breakpoint server 12345`
-"Break" on function: `prvm_breakpoint server ClientConnect`
-Watch for global change: `prvm_globalwatchpoint server time`
-Watch for entity field change: `prvm_edictwatchpoint server 1 health`
-
-There can be only one of each kind. To clear, do:
-```
-prvm_breakpoint server
-prvm_globalwatchpoint server
-prvm_edictwatchpoint server
-```
-
-### Doxygen
-
-Incomplete [Doxygen documentation](https://timepath.github.io/scratchspace/index.html) is generated as part of CI on [xonotic-data.pk3dir](https://gitlab.com/xonotic/xonotic-data.pk3dir) - you can search functions, "classes", globals, etc.
-
-Note that it might be incomplete or incorrect because [Doxygen](https://www.doxygen.nl) doesn't understand all of QC's constructs and our code heavily uses macros. See the `doxygen` section of the [CI file](https://gitlab.com/xonotic/xonotic-data.pk3dir/blob/master/.gitlab-ci.yml) for details what's missing.
-
-### Tool to find C symbols, functions, declarations and definitions inside source code
-
-For this purpose it's possible to use a text-based tool called [Cscope](https://en.wikipedia.org/wiki/Cscope) together with a GUI (it can be either an application or a plugin for a text editor).
-
-##### Download / Installation
-
-* Download and install cscope with `pacman -S cscope`
-Windows users must download the Windows version of cscope from https://code.google.com/archive/p/cscope-win32/downloads and put it into the main xonotic repo directory. The mingw version can't be used as it puts Unix paths into the generated indices, making them unusable.
-
-* Download and install a cscope GUI or a plugin for your text editor / IDE.
- * For [jEdit](http://www.jedit.org) there is a plugin called [CscopeFinder](http://plugins.jedit.org/plugins/?CscopeFinder).
- * For [SublimeText](https://www.sublimetext.com) there is [SublimeCscope](https://github.com/jgust/SublimeCscope)
- * For [Atom](https://atom.io/) there is [atom-cscope](https://atom.io/packages/atom-cscope)
-
-* If you don't use Atom, you also need to copy ~~[cscope_createindex.sh](uploads/17c725e19be8f4935c30c2506e168405/cscope_createindex.sh)(old version)~~ [cscope_createindex.sh](uploads/451835f6b1894145af06050915256048/cscope_createindex.sh) into the main xonotic repo directory.
-
-
-##### Configuration
-
-* Configure your plugin if needed:
- * jEdit's CscopeFinder settings:
- set cscope.out as cscope index filename.
-
- * SublimeCscope user settings (with Windows executable as example):
- ```
- "executable": "C:\\xonotic\\cscope.exe",
- "prompt_before_searching": false,
- ```
-
- * atom-cscope settings:
- 1. set the full path of cscope binary, e.g. C:\xonotic\cscope.exe (with Windows executable as example)
- 1. add .qc and .qh to source file extensions (".c .cc .cpp .h .hpp .qc .qh")
- 1. you also need to create projects for darkplaces and xonotic/data/xonotic-data.pk3dir/qcsrc folders (toggle tree-view with `Ctrl + \`, right-click there and select "Add Project Folder")
-
-* Run `cscope_createindex.sh` to build cscope indices for both game (QC code) and Darkplaces (C code). This step must be repeated every time you do some code changes.
-
-* Some plugins assume that your index file is generated with compression turned on (SublimeCscope's case). In this case `cscope_createindex.sh` can be instructed to use compression by changing `compress=false` to `compress=true`.
-
-* With Atom you can build cscope indices in the atom-cscope window (open with `Ctrl + Alt + o`) by clicking the flash icon.
-
-##### Usage
-
-* jEdit: select a word in the editor, right-click and select "Find this C symbol" or another "Find ..." entry (if you don't see these entries you should add them in the context menu settings).
-* SublimeText: select a word in the editor, right-click and select "Look up symbol" or another "Look up ..." entry.
-* Atom: open atom-cscope window (`Ctrl + Alt + o`) and type a symbol that you want to search.
-
-
-### QC syntax highlighting:
-
-* terencehill's version for jEdit: [qc.xml](https://gitlab.com/terencehill/qc-syntax-highlighting-for-jedit/blob/master/qc.xml)
+### Faster compiling and reloading of QuakeC\r
+\r
+You can use `QCCFLAGS_WERROR=""` to let the build succeed even with some warnings and `ZIP=:` to skip compressing the resulting csprogs.dat (client gamecode) into a pk3. A compressed csprogs.dat is only useful to increase download speed of such file if you host an online dedicated server.\r
+\r
+`QCCFLAGS_WERROR="" ZIP=: ./all compile`\r
+\r
+Server and menu code produce progs.dat and menu.dat respectively.\r
+\r
+Compiling the Xonotic game code without trying to compile the engine code reduces compile time a little bit, in the case you aren't interested in changing the engine code. You can do so by running this command from the xonotic-data.pk3dir directory:\r
+\r
+`make qc -j4`\r
+\r
+where `-j4` is an option that lets you use up to 4 CPU cores for the compilation (it's enabled by default in `./all compile`). If you want you can run `make all -j4` to enable csprogs.dat compression.\r
+\r
+To test the QC client and server programs you don't need to restart Xonotic, you just have to start a new game with `map <mapname>` (depending on how you launch Xonotic you may need to use `fs_rescan; map <mapname>`).\r
+\r
+To test the QC menu program, you just have to restart the menu by executing `menu_restart` in the console.\r
+\r
+### Debug prints\r
+\r
+Use `con_notify 4` together with `LOG_INFOF("my_var: %s", my_var);` (`%s` string, `%f` float, `%d` integer, `%v` vector) to see debug output without opening the console. Type `con_notify` and press `<TAB>` to see descriptions and more options (or use `apropos con_notify`).\r
+\r
+You can draw text anywhere on the map using `debug_text_3d(world_coords, message);` from `common/debug.qh`.\r
+\r
+### Multiple clients + clean config\r
+\r
+If you need 2 players for debugging, you can launch another client locally:\r
+- use -sessionid (e.g. `./all run -sessionid testing`) to keep your config\r
+- use -userdir (e.g. `./all run -userdir ~/.xonotic-testing +name tester +cl_allow_uid2name 0`) to get a clean config (if you delete the dir before each use)\r
+ - you can set any cvar or run any command on start with `+cvar_name value`\r
+ - `+name tester` avoids the nick selection dialog\r
+ - `+cl_allow_uid2name 0` avoids an annoying popup \r
+\r
+### Testing with bots\r
+\r
+You can prevent bots from firing with `bot_nofire 1` or stop them completely with `bot_cmd * pause` (unstop them with `bot_cmd * continue`). With `sv_cheats 1` (takes effect next match), you can drag them around (default key V or 'drag object' in menu).\r
+\r
+Note that `sv_cheats 1` prevents bots from spawning in the campaign (should you decide to put it in your `autoexec.cfg` and later wonder why the campaign is broken).\r
+\r
+### Debugging\r
+\r
+Useful commands to debug qc code:\r
+```\r
+prvm_breakpoint : marks a statement or function as breakpoint (when this is executed, a stack trace is printed); to actually halt and investigate state, combine this with a gdb breakpoint on PRVM_Breakpoint, or with prvm_breakpointdump; run with just progs name to clear breakpoint\r
+\r
+prvm_edict : print all data about an entity number in the selected VM (server, client, menu)\r
+prvm_edictget : retrieves the value of a specified property of a specified entity in the selected VM (server, client menu) into a cvar or to the console\r
+prvm_edicts : prints all data about all entities in the selected VM (server, client, menu)\r
+prvm_edictset : changes value of a specified property of a specified entity in the selected VM (server, client, menu)\r
+prvm_edictwatchpoint : marks an entity field as watchpoint (when this is executed, a stack trace is printed); to actually halt and investigate state, combine this with a gdb breakpoint on PRVM_Breakpoint, or with prvm_breakpointdump; run with just progs name to clear watchpoint\r
+\r
+prvm_global : prints value of a specified global variable in the selected VM (server, client, menu)\r
+prvm_globalget : retrieves the value of a specified global variable in the selected VM (server, client menu) into a cvar or to the console\r
+prvm_globals : prints all global variables in the selected VM (server, client, menu)\r
+prvm_globalset : sets value of a specified global variable in the selected VM (server, client, menu)\r
+prvm_globalwatchpoint : marks a global as watchpoint (when this is executed, a stack trace is printed); to actually halt and investigate state, combine this with a gdb breakpoint on PRVM_Breakpoint, or with prvm_breakpointdump; run with just progs name to clear watchpoint\r
+```\r
+\r
+Examples: \r
+Print to console origin of entity number 1: `prvm_edictget server 1 origin` \r
+Save to a cvar origin of entity number 1: `prvm_edictget server 1 origin my_cvar` \r
+Set a custom origin for entity number 1: `prvm_edictset server 1 origin "100 200 0"`\r
+\r
+Setting view angles requires a particular trick, we also need to set fixangle to true in the same server frame:\r
+`prvm_edictset server 1 fixangle 1; prvm_edictset server 1 angles "20 -90 0"`\r
+\r
+Print to console vid_conheight client global: `prvm_edictget client vid_conheight`\r
+\r
+"Break" on statement: `prvm_breakpoint server 12345` \r
+"Break" on function: `prvm_breakpoint server ClientConnect` \r
+Watch for global change: `prvm_globalwatchpoint server time` \r
+Watch for entity field change: `prvm_edictwatchpoint server 1 health` \r
+\r
+There can be only one of each kind. To clear, do:\r
+```\r
+prvm_breakpoint server\r
+prvm_globalwatchpoint server\r
+prvm_edictwatchpoint server\r
+```\r
+\r
+As of Xonotic 0.8.6 many of those commands are available via shorter aliases:\r
+\r
+```\r
+// breakpoint\r
+alias ps_b "prvm_breakpoint server ${* ?}"\r
+alias pc_b "prvm_breakpoint client ${* ?}"\r
+alias pm_b "prvm_breakpoint menu ${* ?}"\r
+\r
+// entity\r
+alias ps_e "prvm_edict server ${* ?}"\r
+alias pc_e "prvm_edict client ${* ?}"\r
+alias pm_e "prvm_edict menu ${* ?}"\r
+\r
+// field get\r
+alias ps_fg "prvm_edictget server ${* ?}"\r
+alias pc_fg "prvm_edictget client ${* ?}"\r
+alias pm_fg "prvm_edictget menu ${* ?}"\r
+// field set\r
+alias ps_fs "prvm_edictset server ${* ?}"\r
+alias pc_fs "prvm_edictset client ${* ?}"\r
+alias pm_fs "prvm_edictset menu ${* ?}"\r
+// field watchpoint\r
+alias ps_fw "prvm_edictwatchpoint server ${* ?}"\r
+alias pc_fw "prvm_edictwatchpoint client ${* ?}"\r
+alias pm_fw "prvm_edictwatchpoint menu ${* ?}"\r
+\r
+// global get\r
+alias ps_gg "prvm_globalget server ${* ?}"\r
+alias pc_gg "prvm_globalget client ${* ?}"\r
+alias pm_gg "prvm_globalget menu ${* ?}"\r
+// global set\r
+alias ps_gs "prvm_globalset server ${* ?}"\r
+alias pc_gs "prvm_globalset client ${* ?}"\r
+alias pm_gs "prvm_globalset menu ${* ?}"\r
+// global watchpoint\r
+alias ps_gw "prvm_globalwatchpoint server ${* ?}"\r
+alias pc_gw "prvm_globalwatchpoint client ${* ?}"\r
+alias pm_gw "prvm_globalwatchpoint menu ${* ?}"\r
+```\r
+\r
+\r
+### Doxygen\r
+\r
+Incomplete [Doxygen documentation](https://timepath.github.io/scratchspace/index.html) is generated as part of CI on [xonotic-data.pk3dir](https://gitlab.com/xonotic/xonotic-data.pk3dir) - you can search functions, "classes", globals, etc.\r
+\r
+Note that it might be incomplete or incorrect because [Doxygen](https://www.doxygen.nl) doesn't understand all of QC's constructs and our code heavily uses macros. See the `doxygen` section of the [CI file](https://gitlab.com/xonotic/xonotic-data.pk3dir/blob/master/.gitlab-ci.yml) for details what's missing.\r
+\r
+### Tool to find C symbols, functions, declarations and definitions inside source code\r
+\r
+For this purpose it's possible to use a text-based tool called [Cscope](https://en.wikipedia.org/wiki/Cscope) together with a GUI (it can be either an application or a plugin for a text editor).\r
+\r
+##### Download / Installation\r
+\r
+* Download and install cscope with `pacman -S cscope` \r
+Windows users must download the Windows version of cscope from https://code.google.com/archive/p/cscope-win32/downloads and put it into the main xonotic repo directory. The mingw version can't be used as it puts Unix paths into the generated indices, making them unusable.\r
+\r
+* Download and install a cscope GUI or a plugin for your text editor / IDE.\r
+ * For [jEdit](http://www.jedit.org) there is a plugin called [CscopeFinder](http://plugins.jedit.org/plugins/?CscopeFinder).\r
+ * For [SublimeText](https://www.sublimetext.com) there is [SublimeCscope](https://github.com/jgust/SublimeCscope)\r
+ * For [Atom](https://atom.io/) there is [atom-cscope](https://atom.io/packages/atom-cscope)\r
+\r
+* If you don't use Atom, you also need to copy ~~[cscope_createindex.sh](uploads/17c725e19be8f4935c30c2506e168405/cscope_createindex.sh)(old version)~~ [cscope_createindex.sh](uploads/451835f6b1894145af06050915256048/cscope_createindex.sh) into the main xonotic repo directory.\r
+\r
+\r
+##### Configuration\r
+\r
+* Configure your plugin if needed: \r
+ * jEdit's CscopeFinder settings: \r
+ set cscope.out as cscope index filename. \r
+\r
+ * SublimeCscope user settings (with Windows executable as example):\r
+ ```\r
+ "executable": "C:\\xonotic\\cscope.exe",\r
+ "prompt_before_searching": false,\r
+ ```\r
+\r
+ * atom-cscope settings:\r
+ 1. set the full path of cscope binary, e.g. C:\xonotic\cscope.exe (with Windows executable as example) \r
+ 1. add .qc and .qh to source file extensions (".c .cc .cpp .h .hpp .qc .qh")\r
+ 1. you also need to create projects for darkplaces and xonotic/data/xonotic-data.pk3dir/qcsrc folders (toggle tree-view with `Ctrl + \`, right-click there and select "Add Project Folder")\r
+\r
+* Run `cscope_createindex.sh` to build cscope indices for both game (QC code) and Darkplaces (C code). This step must be repeated every time you do some code changes.\r
+\r
+* Some plugins assume that your index file is generated with compression turned on (SublimeCscope's case). In this case `cscope_createindex.sh` can be instructed to use compression by changing `compress=false` to `compress=true`.\r
+\r
+* With Atom you can build cscope indices in the atom-cscope window (open with `Ctrl + Alt + o`) by clicking the flash icon.\r
+\r
+##### Usage\r
+\r
+* jEdit: select a word in the editor, right-click and select "Find this C symbol" or another "Find ..." entry (if you don't see these entries you should add them in the context menu settings).\r
+* SublimeText: select a word in the editor, right-click and select "Look up symbol" or another "Look up ..." entry.\r
+* Atom: open atom-cscope window (`Ctrl + Alt + o`) and type a symbol that you want to search.\r
+\r
+\r
+### QC syntax highlighting:\r
+\r
+* terencehill's version for jEdit: [qc.xml](https://gitlab.com/terencehill/qc-syntax-highlighting-for-jedit/blob/master/qc.xml)\r
* EACFreddy's version for Kate: [qc.xml](https://gist.github.com/DefaultUser/998f030ab41a9e8edf4a9f8e703c6350)
\ No newline at end of file
projects / xonotic / xonotic.wiki.git / commitdiff