Development Tools - Revision history

Impaktor: Update Misc section with hot reloading modules and make into bullet list

2023-09-15T09:17:57Z

Update Misc section with hot reloading modules and make into bullet list

Impaktor: /* Debug from in-game */

2023-09-15T09:13:27Z

‎Debug from in-game

Zonkmachine: /* Compile with Debug support */ fix broken link to same or same-ish tutorial at same site

2023-01-02T01:50:22Z

‎Compile with Debug support: fix broken link to same or same-ish tutorial at same site

Impaktor: /* Compile with Debug support */

2022-10-01T10:20:54Z

‎Compile with Debug support

Impaktor: /* Debug */

2022-07-18T10:28:14Z

‎Debug

Impaktor: /* Profiling */

2022-06-19T19:52:37Z

‎Profiling

Impaktor: /* Debug */

2022-06-03T19:11:03Z

‎Debug

Impaktor: /* Debug */

2022-03-01T19:50:58Z

‎Debug

Gliese852: /* Editor integration */

2022-01-06T17:47:17Z

‎Editor integration

Impaktor: /* Profiling */

2021-05-28T08:51:55Z

‎Profiling

@@ Line 45: / Line 45: @@
 === Misc. ===
-Pioneer can dump galaxy information, to make sure the galaxy hasn't changed, or to gather statistics, described here:
+* Pioneer can dump galaxy information, to make sure the galaxy hasn't changed, or to gather statistics, described in [https://github.com/pioneerspacesim/pioneer/pull/2811 #2811]
-The quit confirmation box can be supressed by putting ConfirmQuit=0 in the pioneer configuration file
+* The quit confirmation box can be supressed by putting ConfirmQuit=0 in the pioneer configuration file
 == Profiling ==

@@ Line 21: / Line 21: @@
 === Debug from in-game ===
-Ctrl+I = debug window
+Ctrl+I open debug window
 Ctrl+F10 open planet viewer, to view selected nav target
@@ Line 28: / Line 28: @@
 Ctrl+Del reload pigui element, allows for live coding. Limited support: Only reloads the active view and then only if the active view has manually enabled it (add `debugReload = function() package.reimport() end` to the view's definition next to the draw and refresh functions)
 === Debug savegame files ===

@@ Line 9: / Line 9: @@
      ./bootstrap -DCMAKE_BUILD_TYPE=Debug
-You can now use debugger, like [https://felix-knorr.net/blog/using_gdb_directly.html gdb] (for more advanced gdb tricks see [https://begriffs.com/posts/2022-07-17-debugging-gdb-ddd.html Pleasant debugging with GDB and DDD]; there's also [https://github.com/epasveer/seer GUI available] for gdb.)
+You can now use debugger, like [https://felix-knorr.net/posts/2022-02-27-direct-gdb.html gdb] (for more advanced gdb tricks see [https://begriffs.com/posts/2022-07-17-debugging-gdb-ddd.html Pleasant debugging with GDB and DDD]; there's also [https://github.com/epasveer/seer GUI available] for gdb.)
 === Document weirdness ===

@@ Line 9: / Line 9: @@
      ./bootstrap -DCMAKE_BUILD_TYPE=Debug
-You can now use debugger, like [https://felix-knorr.net/blog/using_gdb_directly.html gdb] (for more advanced gdb tricks see [https://begriffs.com/posts/2022-07-17-debugging-gdb-ddd.html Pleasant debugging with GDB and DDD])
+You can now use debugger, like [https://felix-knorr.net/blog/using_gdb_directly.html gdb] (for more advanced gdb tricks see [https://begriffs.com/posts/2022-07-17-debugging-gdb-ddd.html Pleasant debugging with GDB and DDD]; there's also [https://github.com/epasveer/seer GUI available] for gdb.)
 === Document weirdness ===

@@ Line 9: / Line 9: @@
      ./bootstrap -DCMAKE_BUILD_TYPE=Debug
-You can now use debugger, like [https://felix-knorr.net/blog/using_gdb_directly.html gdb]
+You can now use debugger, like [https://felix-knorr.net/blog/using_gdb_directly.html gdb] (for more advanced gdb tricks see [https://begriffs.com/posts/2022-07-17-debugging-gdb-ddd.html Pleasant debugging with GDB and DDD])
 === Document weirdness ===

@@ Line 54: / Line 54: @@
 Now new profiling functions merged:
 [https://github.com/pioneerspacesim/pioneer/pull/5168 Add zone-based profiling support #5168]
 === Build with profiling support ===

← Older revision		Revision as of 19:11, 3 June 2022
Line 34:		Line 34:

	and look in your savefile folder (e.g. ~/.pioneer/savefiles on linux) at <mysavename>.json file, put JSON e.g. into http://jsonviewer.stack.hu/		and look in your savefile folder (e.g. ~/.pioneer/savefiles on linux) at <mysavename>.json file, put JSON e.g. into http://jsonviewer.stack.hu/
		+
		+
		+	=== Debug Lua Callstack ===
		+
		+	A lua callstack can also help - there's a function in lua/core/Sandbox.cpp that can be called in the debugger to get a callstack

@@ Line 4: / Line 4: @@
 == Debug ==
 Build debug
      ./bootstrap -DCMAKE_BUILD_TYPE=Debug
 To record video from gameplay (e.g. to document unexpected behavior):

← Older revision		Revision as of 17:47, 6 January 2022
Line 85:		Line 85:
	https://github.com/pioneerspacesim/pioneer/pull/3768		https://github.com/pioneerspacesim/pioneer/pull/3768
	https://github.com/pioneerspacesim/pioneer/pull/4799		https://github.com/pioneerspacesim/pioneer/pull/4799
		+
		+	=== Easy start (Linux) ===
		+
		+	1. Reconfigure with remote lua console support and rebuild:
		+	./bootstrap -DREMOTE_LUA_REPL=ON
		+	make -C build -j4
		+
		+	2. Now after starting a new, or loading a saved game, you can connect to the program via telnet on port '''12345''':
		+
		+	$ telnet localhost 12345
		+	Trying 127.0.0.1...
		+	Connected to localhost.
		+	Escape character is '^]'.
		+	** Welcome to the Pioneer Remote Debugging Console!
		+	>
		+
		+	Now you can run any lua commands.
		+
		+	=== Example of use with VIM for hot reloading of the module ===
		+
		+	I added the following code to '''~/.vimrc:'''
		+	nmap ;mm :w<CR>:call PioneerReloadModuleFnc(expand("%"))<CR><CR>
		+	function! PioneerReloadModuleFnc(filename)
		+	let s:data = strcharpart(a:filename, 0, 4)
		+	let s:lua = strcharpart(a:filename, strlen(a:filename) - 3, 4)
		+	if s:data == "data" && s:lua == "lua"
		+	let s:crop = strcharpart(a:filename, 5, strlen(a:filename) - 9)
		+	let s:convert = substitute(s:crop, "/", ".", "g")
		+	let s:command = "package.reimport(\"" . s:convert . "\")"
		+	:execute "!echo '". s:command . "' \| telnet localhost 12345"
		+	else
		+	:echom "ERROR: file should be \"*.lua\" and in \"data\" subfolder"
		+	endif
		+	endfunction
		+
		+	Now when pressing the combination ''';mm''' in normal mode, the file is saved, then telnet is launched and the command is sent:
		+	package.reimport(<your module name>)
		+	where the module name is taken from the name of the file being edited. This leads to a reload of this module without restarting the game.
		+
		+	A short video of how it might look: https://youtu.be/f5s_tuAv6fc

@@ Line 43: / Line 43: @@
 For Profiling, one needs some tools installed?
 === Build with profiling support ===
@@ Line 77: / Line 79: @@
      - there's little difference between the `autoformat` script and the `scripts/clang-format.sh` script other than the
      latter prompts you to automatically apply the issues in your files.
 == Editor integration ==