source: nikanabo/current/readme.txt @ 353

Last change on this file since 353 was 185, checked in by geyser, 13 years ago
File size: 1.8 KB
Line 
1Welcome to ONI NI KANABO... (beta ^^)
2This should be Oni/nikanabo/readme.txt
3______________________________
4
5Scripted mods are in the "bsl" folder
6Binary mods are in the "dat" folder
7Xdelta (binary patcher) is in "xdelta".
8
9In every mod's folder you will find
10- a description of the mod (text file)
11- one or more installers (shell scripts)
12- possibly (later) descriptors for GUI
13- other stuff (screenshots, whatever)
14
15More generally, in every folder you'll
16find a text file telling you what there
17is there, and what you're supposed to do.
18______________________________
19
20Windows folks: just click the batch files.
21Mac and Linux folks: terminal only, sorry.
22
23On most UNIX platforms, the current directory
24AKA "." is not part of the PATH variable, so
25"whatever.sh" won't work. Use "sh whatever.sh"
26or just "./whatever.sh"
27
28Autocompletion should make things bearable.
29A *portable* GUI is of course very welcome ^^
30______________________________
31
32New mod contributors are invited to pack the
33whole tree with their mod, like this:
34nikanabo/bsl/mod_name/*.*
35nikanabo/dat/mod_name/*.*
36so users only have to unzip it into "Oni".
37______________________________
38
39BACKUPS : IMPORTANT
40
41Before you install any mod, you'll have to
42run the proper backup script for your
43platform, namely:
44        wbackup.bat     for Windows
45        xbackup.sh      for Mac/Linux
46
47The installer scripts provided will complain
48if the backup is missing (and do nothing).
49______________________________
50
51PERMISSIONS: NOTE TO EXPERTS ^^
52
53Depending on your system, you may
54need to enable the execute permission
55manually for the script to run, e.g.:
56
57chmod +x xbackup.sh
58
59From what I've seen, this is never needed,
60since non-read-only content seems to get
61"rwxr-xr-x" by default on Mac and Linux.
Note: See TracBrowser for help on using the repository browser.