Skip to content

Commit 33715f5

Browse files
committed
Added ReadMe.md and License.txt
1 parent 6e2f9a0 commit 33715f5

2 files changed

Lines changed: 114 additions & 0 deletions

File tree

License.txt

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
New BSD
2+
3+
Copyright © 2013, Athari
4+
All rights reserved.
5+
6+
Redistribution and use in source and binary forms, with or without modification,
7+
are permitted provided that the following conditions are met:
8+
9+
* Redistributions of source code must retain the above copyright notice, this
10+
list of conditions and the following disclaimer.
11+
12+
* Redistributions in binary form must reproduce the above copyright notice, this
13+
list of conditions and the following disclaimer in the documentation and/or
14+
other materials provided with the distribution.
15+
16+
* Neither the name of the Athari nor the names of other contributors may be used
17+
to endorse or promote products derived from this software without specific
18+
prior written permission.
19+
20+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
21+
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
22+
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
23+
DISCLAIMED. IN NO EVENT SHALL ATHARI BE LIABLE FOR ANY DIRECT, INDIRECT,
24+
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25+
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
26+
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
27+
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
28+
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
29+
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

ReadMe.md

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
Alba.XnaConvert
2+
===============
3+
4+
Command-line utility for converting XNA XNB files.
5+
6+
Features
7+
--------
8+
9+
* Converting Texture2D XNB files to PNG images.
10+
* All versions of XNA are supported: 1.0, 2.0, 3.0, 3.1, 4.0.
11+
12+
N.B.
13+
----
14+
15+
Do not forget: the fact that you *can technically extract* and view the resources from some games does not mean you *can legally use* the resources. Even extracting can be illegal in your country. If you are unsure, do not use this program.
16+
17+
Installation
18+
------------
19+
20+
You need to install the following redistributable packages before using the program (also necessary for compiling from sources):
21+
22+
* [Microsoft .NET Framework 4.5](http://www.microsoft.com/en-us/download/details.aspx?id=30653)
23+
* [Microsoft XNA Framework Redistributable 1.0](http://www.microsoft.com/en-us/download/details.aspx?id=2431)
24+
* [Microsoft XNA Framework Redistributable 2.0](http://www.microsoft.com/en-us/download/details.aspx?id=15537)
25+
* [Microsoft XNA Framework Redistributable 3.0](http://www.microsoft.com/en-us/download/details.aspx?id=22588)
26+
* [Microsoft XNA Framework Redistributable 3.1](http://www.microsoft.com/en-us/download/details.aspx?id=15163)
27+
* [Microsoft XNA Framework Redistributable 4.0](http://www.microsoft.com/en-us/download/details.aspx?id=20914)
28+
29+
Command line
30+
------------
31+
32+
**Verb: convert**
33+
34+
Convert file from one format to another.
35+
36+
Options:
37+
38+
* `-l, --library` *(Default: XNA)* Library name.
39+
* `-v, --version` *(Default: 4.0)* Library version.
40+
* `-i, --input` *(Required)* Input file (*.xnb).
41+
* `-d, --inputdir` *(Required)* Input directory (with *.xnb files).
42+
* `-m, --mask` *(Default: *.xnb)* Input mask (with *.xnb files).
43+
* `-r, --recursive` *(Default: false)* Process files in input directory recursively.
44+
* `-o, --output` *(Required)* Output file or directory.
45+
46+
Examples:
47+
48+
Alba.XnaConvert convert -v 4 -d "C:\Games\Terraria\Content\Images" -o "C:\Unpacked\Terraria"
49+
Alba.XnaConvert convert -v 4 -r -d "C:\Games\Dust An Elysian Tail\content\gfx" -o "C:\Unpacked\Dust An Elysian Tail"
50+
Alba.XnaConvert convert -v 3.1 -r -d "C:\Games\Capsized\Content" -o "C:\Unpacked\Capsized"
51+
Alba.XnaConvert convert -v 3 -d "C:\Games\Blueberry Garden\Content" -o "C:\Unpacked\Blueberry Garden"
52+
53+
**Verb: listlibs**
54+
55+
List supported libraries and versions.
56+
57+
Options:
58+
59+
* `-a, --all` *(Default: false)* Include all aliases.
60+
61+
Examples:
62+
63+
Alba.XnaConvert listlibs
64+
Alba.XnaConvert listlibs --all
65+
66+
Known issues
67+
------------
68+
69+
1. XNA sometimes fails to properly free resources. If multiple huge images are converted and your computer is low on memory, the program will terminate. *Workaround:* run the program again. It will skip already converted files.
70+
71+
License
72+
-------
73+
74+
**New BSD**
75+
76+
Copyright © 2013, Athari
77+
All rights reserved.
78+
79+
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
80+
81+
* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
82+
* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
83+
* Neither the name of the Athari nor the names of other contributors may be used to endorse or promote products derived from this software without specific prior written permission.
84+
85+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ATHARI BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

0 commit comments

Comments
 (0)