]> Chaos Git - vn/FSNConverter-Linux.git/commitdiff
Clean up readme and make it markdown
authorchaoskagami <chaos.kagami@gmail.com>
Wed, 20 Aug 2014 17:04:34 +0000 (13:04 -0400)
committerchaoskagami <chaos.kagami@gmail.com>
Wed, 20 Aug 2014 17:04:34 +0000 (13:04 -0400)
README.md [new file with mode: 0644]
README.txt [deleted file]

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..17f341e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,46 @@
+Fate/Stay Night VNDS Converter (on linux!) [![Build Status](https://travis-ci.org/chaoskagami/FSNConverter-Linux.svg?branch=master)](https://travis-ci.org/chaoskagami/FSNConverter-Linux)
+
+Yet another one of my random portish things. The Fate/Stay night VNDS converter from over at weaboo.nl - at first glance looked very unixy-okay, so I figured I might be able to just run it on linux.
+It wasn't nearly that simple. Some code used windows APIs for files, and some code was weird.
+
+The issues I ran into:
+ - Posix API not used for file access. I replaced the API in C close to 1:1
+ - Bad code. Like 0[ptr++] . It's not ASLR friendly. Hell, it should probably just segfault.
+ - Do not hardcode C: and Z: into your java. Repeat, don't hardcode windows paths.
+ - ffmpeg and libav are both the same thing, but the program only uses ffmpeg
+ - System tools really should be preferred and/or required on linux.
+
+These are needed to compile this, as well as the below:
+ - ant
+ - gcc
+ - g++
+ - bash (I don't use ash or zsh. Sorry. Some adjustment might be needed.)
+ - > jdk1.6
+
+Install these dependencies to run the blob:
+ - pngcrush
+ - ffmpeg/libav
+ - liboggz
+ - > java1.7 (Note: I build with openjdk-7. There's no reason why 1.6 shouldn't work other than outdatedness)
+
+These are optional as long as you don't use the quantization functions:
+ - pngquant
+ - pngnq
+
+FAQ:
+       Q: So let me get this straight. Fate is a windows game, and you're 
+          running a tool on linux to convert for android. WTF is wrong with
+          you.
+       A: There's this thing called a 'canadian-cross' compiler. This is like
+          that. So no, not crazy.
+
+       Q: Does this work?
+       A: For the most part. During conversion I DID get a few warnings spat
+          out about some tlg files.
+
+       Q: I never managed to get fate to run on wine. HELP
+       A: Install Dx9. Also, you probably won't get the videos working so
+          rename video.xp3 to video.xp3.disabled or something.
+
+For license read COPYING. tl;dr same as weaboo.nl, since I can't change the
+license ( GPLv2 ) nor do I want to in this case.
diff --git a/README.txt b/README.txt
deleted file mode 100644 (file)
index 0a00c84..0000000
+++ /dev/null
@@ -1,50 +0,0 @@
-What is this?
-
-- Yet another one of my random portish things. The Fate/Stay night VNDS 
-converter at first glance looked very unixy-okay, so I figured I might 
-be able to just run it on linux.
-- Not exactly.
-
-Here was my list of concerns:
- - Bundled tools.
- - Java code putting C: and Z: in automatically.
- - No regard for system tools.
- - Source code is windows specific.
- - Launch4j needs butchering.
-
-Basically, I've fixed all of these imperfectly. Enough to use it to do 
-its job. As proof, the fate version I'm playing right now was a byproduct of
-this.
-
- - Misc tools converted. Lotta windows calls ugh
- - Java code altered a bit. Some things needed to go.
- - tools has been renamed to bin, and we append it to the path instead.
- - System tools preferred, and in most cases, required.
-
-Install these deps or you won't be getting anywhere:
- - pngcrush
- - ffmpeg/libav
- - liboggz
- - ant
- - java1.6
-These are optional.
- - pngquant
- - pngnq
-
-FAQ:
-       Q: So let me get this straight. Fate is a windows game, and you're 
-          running a tool on linux to convert for android. WTF is wrong with
-          you.
-       A: There's this thing called a 'canadian-cross' compiler. This is like
-          that. So no, not crazy.
-
-       Q: Does this work?
-       A: For the most part. During conversion I DID get a few warnings spat
-          out about some tlg files.
-
-       Q: I never managed to get fate to run on wine. HELP
-       A: Install Dx9. Also, you probably won't get the videos working so
-          rename video.xp3 to video.xp3.disabled or something.
-
-For license read COPYING. tl;dr same as weaboo.nl, since I can't change the
-license ( GPLv2 ) nor do I want to in this case.