Skip to content

Commit 8a2a869

Browse files
authored
docs: Update README with build instructions
1 parent 395db97 commit 8a2a869

File tree

1 file changed

+32
-8
lines changed

1 file changed

+32
-8
lines changed

README.md

Lines changed: 32 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ If you have an Xbox One development kit or GamingServices framework (Windows10-e
1515
Also included is a tool for extracting files from the XBFS (Xbox Boot File System) inside the Xbox One NAND, based on tuxuser's original [NANDOne](https://github.com/tuxuser/NANDOne) work with a few small additions.
1616
Thanks Kebob for providing [OpenXvd](https://github.com/Kebob/OpenXvd).
1717

18-
### Usage
18+
## Usage
1919
```
2020
Usage : xvdtool.exe [parameters] [filename]
2121
@@ -74,7 +74,7 @@ Decrypting XVC packages is a different matter, XVC packages use a **Content Inst
7474

7575
Devkit/test-signed XVC packages use a static CIK which is also "widely known" (Hash provided below).
7676

77-
### Required Files
77+
## Required Files
7878
To make full use of this tool you'll need the following files, which **are not included**. The tool will work fine without them, but some functions might not work.
7979

8080
You can use the included tool "DurangoKeyExtractor" to extract these keys from the Microsoft.GamingServices framework available on Windows 10.
@@ -108,12 +108,12 @@ To chose a specific key use the following cmdline switches:
108108
-cik (-cikguid) <GUID> - Guid of Content Instance key to use
109109
```
110110

111-
#### Mounting XVDs
111+
### Mounting XVDs
112112

113113
For mounting of XVD/XVC files, you require DLLs from [GamingServices](https://www.microsoft.com/en-us/p/gaming-services/9mwpm2cqnlhn?activetab=pivot:overviewtab) component.
114114
Download & install it via the Microsoft Store and you should be good to go.
115115

116-
### Possible locations to store keys
116+
## Possible locations to store keys
117117
XVDTool will create configuration/keys folders on first start - Global and local to the app.
118118

119119
Global configuration folder:
@@ -131,23 +131,47 @@ Inside these folders you can can store your keys to be autoloaded.
131131

132132
Additionally, you can provide keys from arbitrary filesystem locations via the respective cmdline switches: `-signfile, -odkfile, -cikfile`
133133

134-
#### Naming the keys
134+
### Naming the keys
135135
For CIK it is not important how the keys are named if they have the binary structure of `[16 byte encryption key GUID][32 byte CIK]`.
136136
XVD signing keys should have a distinct identifier so you can refer to them via the `-sk (-signkey)` cmdline switch.
137137
ODK needs to be named either by OdkIndex (`<index>.odk`) or by its identifier: `RedOdk.odk, StandardOdk.odk etc.`
138138
For detailed up-to-date info refer to: `LibXboxOne/Keys/`
139139

140-
### What are XVDs?
140+
## What are XVDs?
141141
XVD packages are a secured file format used by the Xbox One to store data, an analogue to the Xbox 360's STFS packages. XVD files are usually used to store system images/data while XVCs (a slightly modified variant of XVDs) are used to store game data.
142142

143143
For a more detailed explanation of XVD files see xvd_info.md
144144

145-
### Third party libraries used
145+
## Third party libraries used
146146
* BouncyCastle (https://www.bouncycastle.org/csharp/)
147147
* NDesk.Options (http://www.ndesk.org/Options)
148148
* DiscUtils (https://github.com/DiscUtils/DiscUtils)
149149

150-
### Help / Support
150+
## Building from source
151+
152+
### Requirements
153+
154+
- [.NET 7.0 SDK](https://dotnet.microsoft.com/en-us/download/dotnet/7.0) - Choose Installer x64 for ease of use
155+
156+
### Building
157+
158+
- After installing the SDK, open up a new powershell window
159+
- Clone the repository
160+
```
161+
git clone https://github.com/emoose/xvdtool
162+
```
163+
- Navigate into the directory
164+
```
165+
cd xvdtool
166+
```
167+
- Build
168+
```
169+
dotnet build -c Release
170+
```
171+
172+
NOTE: If you want to build as DEBUG, either omit `-c Release` or supply `-c Debug` instead.
173+
174+
## Help / Support
151175
xvdtool has been tested on Windows and MacOS but it should work on all systems supported by .NET Core.
152176

153177
There's no help given for this tool besides this readme, it's also currently **very** experimental and **very** likely to blow up in your face. If you do encounter any bugs please submit a description of what happened to the issue tracker.

0 commit comments

Comments
 (0)