Skip to content

Commit 3d8ecdf

Browse files
committed
add basic readme
1 parent 5105c3f commit 3d8ecdf

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# VDBTCP - Vita TCP Debugger Companion
2+
3+
This plugin is a companion utility for the vita kernel-side debugger plugin: [kvdb][1]. You cannot use this application without that plugin already installed.
4+
5+
This plugin provides TCP/IP support for debugging applications on the vita. It also provides persistant FTP server and a [vitacompanion][2] compatible API.
6+
7+
If you are looking to debug your own application, you are probably looking to use this plugin.
8+
9+
## Install
10+
To install copy this plugin to your device, and add it your `config.txt` under the `[main]` category.
11+
12+
## Usage
13+
This provides three services:
14+
* GDB stub on port 31337.
15+
* FTP server on port 1337.
16+
* vitacompanion service on port 1338.
17+
18+
This plugin can be used to launch an application in debug mode. To do this, you need to issue a `launch` command to the vitacompanion service on port 1338. This command differs from typical vitacompanion and has the following format:
19+
```
20+
launch /path/on/vita/to/self
21+
```
22+
Once you issue this command the vita will launch it, and the debugger will automatically attach and you can use the GDB protocol on port 31337 to debug it.
23+
24+
## Integrations into IDE
25+
Coming soon: VSCode example.
26+
27+
tl;dr:
28+
* Deploy application via FTP.
29+
* Issue launch command to Vita.
30+
* Attach to remote GDB process using IDE.
31+
32+
This method should work for most IDEs, but the specific integration will differ for each.
33+
34+
[1]: https://github.com/DaveeFTW/kvdb
35+
[2]: https://github.com/devnoname120/vitacompanion

0 commit comments

Comments
 (0)