Support OpenKore:
Learn about
the Fund Pool

SVN guide for users

« What is SVN?


Contents

Preparations

First, you will need to install an SVN client in order to access SVN servers, just like you need a web browser to access HTTP servers. For Windows, I recommend TortoiseSVN.

This guide assumes that you use TortoiseSVN.


Configure TortoiseSVN

This step is very important, as it will tell TortoiseSVN to correctly convert Unix line endings to Windows line endings in text files.


(Screenshot of the Settings menu; click to enlarge)
Rightclick on an empty spot on your desktop, and click on TortoiseSVN->Settings. A dialog will appear.

(Screenshot of the Settings dialog; click to enlarge)
Click on the ''Edit'' button on the right of ''Subversion configuration file''. Notepad will appear.

In Notepad, find this line:

# enable-auto-props = yes

Change it to:

enable-auto-props = yes

Find this line:

# *.c = svn:eol-style=native

After that line, add the following text:

*.c = svn:eol-style=native
*.cpp = svn:eol-style=native
*.h = svn:eol-style=native
*.dsp = svn:eol-style=CRLF
*.dsw = svn:eol-style=CRLF
*.sh = svn:eol-style=native;svn:executable
*.txt = svn:eol-style=native
*.png = svn:mime-type=image/png
*.jpg = svn:mime-type=image/jpeg
Makefile = svn:eol-style=native
SConscript = svn:eol-style=native
SConstruct = svn:eol-style=native
Distfiles = svn:eol-style=native
*.url = svn:eol-style=CRLF
*.bat = svn:eol-style=CRLF
*.pas = svn:eol-style=CRLF
*.dfm = svn:eol-style=CRLF
*.pl = svn:eol-style=native;svn:executable
*.pm = svn:eol-style=native
*.html = svn:eol-style=native
*.pm = svn:eol-style=native
*.py = svn:eol-style=native
*.js = svn:eol-style=native
*.css = svn:eol-style=native
*.pc = svn:eol-style=native
*.svg = svn:eol-style=native
*.xs = svn:eol-style=native
*.po = svn:eol-style=native
*.pot = svn:eol-style=native

When you're done, save the file and proceed to the next paragraph.


Download (checkout) a module from SVN

The OpenKore SVN repository contains several modules. A module is a subfolder on the SVN server, containing an OpenKore-related project. You're probably looking for the openkore module. For other modules, see the list of SVN modules.


(Screenshot of the Checkout menu)
Rightclick on an empty spot on your desktop, and click on SVN Checkout....

(Screenshot of the Checkout
dialog; click to enlarge)
A dialog will appear. Fill in this for the URL of repository field:
https://openkore.svn.sourceforge.net/svnroot/openkore/openkore/trunk
In the Checkout directory field, fill in the path to the folder you want to download the files to.

Click OK when you're done.


(Screenshot of the certification
confirmation dialog; click to enlarge)
A certification confirmation dialog may appear. In that case, click Accept Permanently.

(Screenshot of the checkout
dialog; click to enlarge)
TortoiseSVN will now start checking out the module. Wait until it's done and click OK.

You have now checked out OpenKore from SVN. The SVN version of OpenKore may use different configuration files and table files than the latest released version. So you are encouraged to also check out the confpack and tablepack SVN modules.


Regularly update the module

You should regularly update the module. This means telling TortoiseSVN to download the latest files from SVN. TortoiseSVN will only download the things that have changed, so it saves bandwidth.

Rightclick on an empty spot in the module's folder and choose SVN Update. That's all.


Running OpenKore SVN version

To start OpenKore, see Running OpenKore from source.


Frequently asked questions about SVN

How do I use SVN in Linux/Unix?

First you need to install Subversion if you don't already have it.

You can checkout the openkore SVN module with the following command:

svn checkout https://openkore.svn.sourceforge.net/svnroot/openkore/openkore/trunk/

See also List of SVN modules for the URLs of other modules.


The SourceForge SVN server keeps giving me errors; is there an alternative way to download?

Yes. Currently there are two svn mirrors, they are:

- OpenKore SVN Zips The archives(*.zip) are generated as soon as someone committed to SVN.
- OpenKore SVN Tarballs The archives(*.tar.gz) are regenerated hourly.

What is the hidden .svn folder? Can I delete it?

The .svn folder is used by TortoiseSVN to store various information, such as the URL of the SVN server. Deleting or modifying this folder will disable your ability to update from SVN.