1. This site uses cookies. By continuing to use this site, you are agreeing to our use of cookies. Learn More.
  2. Hey Guest, If you'd like to instant message with many other users, then join our
    Official Rune-Status Discord Server!
    Dismiss Notice
  3. Got your own Server? Looking for a Server to play right now??
    Make sure you check out the Public Server Directory!
    Dismiss Notice
  4. If you're new to the Rsps Scene and want to jump straight into learning how to Set-up and Customise your own RuneScape Private Sever then check out the Guides and Tutorials for RS2 here.
    Dismiss Notice
Dismiss Notice
Hey Guest,
Are you sure your posting in the Right Sections?
If your unsure which RuneTek version you are working with visit this page to find out.

How-to create RS2 Hybrids Pt.2: Packing OSRS Data

Discussion in 'Guides & Tutorials' started by Ian, Sep 3, 2017.

  1. Hey guys,
    Welcome back to Pt.2: Packing of the guide, Now writing this I assume you have followed Pt.1: Dumping of the guide, which was essential to get the correctly formatted data dumps to be able to continue on with this guide.

    So in this guide I will explain you through the steps in 'Packing' the OSRS Data we previously Dumped in the RS2 format into the actual RS2 Cache. Now again like I stated during the previous part I will be using the Astreaus-V2 Client which was posted on Github by Chad Alan - You can find a Fork of this on the Rune-Status Github page if you haven't already followed the 'How-to set-up an Rsps Pt2: Client' tutorial here on the forums, which explains the best way to Download and Run the Astreaus-V2 Client.

    Without further adieu, if you haven't already followed Pt.1 of this guide:
    Please do so now, then come back and let's move on. Already done? Sweet let's get packing.

    Important Note: Please make a backup of your Original Client Cache before you attempt to pack data into it!

    Now there are handful of tools openly available on the web that enable you to edit the Cache of the RS2/317 Cache, but for this tutorial we will be again using another one of Chad Alans tools which is called 'RuneScape2 Asset Manager' (rsam-gui.jar) and you can find this tool attached at the bottom of the post, please proceed to download that now - we will be using this tool throughout the tutorial. We are using the GUI version of the tool as the Library itself is useful for Server development to be able to read the cache and use the data loaded for purposes such as Clipping regions, Grabbing Item information, etc. But for this part we will be using the GUI version for simply ease of use.

    Providing that you followed Pt.1 of the guide you will have a project folder named 'Data Dumping Pack' somewhere local on your computer which has all the Data we dumped contain within it, for the first step of this guide we are going to repack the 'Indices' of the cache, these are the Models, Animations, Midis and Maps of the Client, Indices 1 through 4. A lot of people have problems with this part so this is why I will guide you through it first, as the packing the 'Configs' is relatively straight forward afterwards.

    Firstly open your 'astreaus-v2-client' Project in your IDE and navigate to a File called Configuration.java, which can be found in the 'io.astreaus' package, This class is where all the switch settings can be found for the Client, from turning debugging information on/off to enabling/disabling World Switching. What we are looking for are a bunch of Booleans named 'repackIndex*',

        * Used to repack indexes Index 1 = Models Index 2 = Animations Index 3 =
        * Sounds/Music Index 4 = Maps
        public static boolean repackIndexOne = false, repackIndexTwo = false, repackIndexThree = false, repackIndexFour = false;

    as you can see they are all currently set to false, though once changed to true and the Client is ran, while starting up the Client will go on to try to find the 'index#' (1-4) folders inside the './data/Cache/' folder found alongside the Clients files, and try to move the files contained within them into the Cache, this wont work if the indices folders are missing and will just throw a FileNotFound error in your output. However for now, set these all too True.

    Next thing we need to do is make sure that the indices folders are available in the './data/Cache/' folder, so go into your 'Data Dumping Pack/_CACHE/154u2/data' folder and Copy the four folders, 'index1', 'index2' (remember we renamed anims folder to index2), 'index3' and 'index4' - and paste these into the './data/Cache/' folder.
    Once done you can then Proceed to run the 'astreaus-v2-client' from your IDE, which will launch the Client and on start-up will repack the data into the Cache. This may take some time as there are for just 'index1' 33_206 files (rev.154u2) As soon as you are prompted to Login with the Client you will know the process has completed and can then Close the Client.
    Note: Once the process has completed and you have closed the client please go on to change the 'repackIndex*' booleans back to false, otherwise each time you run the client it will run through the whole process again.
    Note: You may notice that when finished repacking you have a folder called 'dump4' in your './data/Cache/' folder, this is down to a typo in the Client source - to stop this happening again go into Client.java and search for 'repackIndexFour' you will notice it has two occurances instead of one. You will need to change the second 'repackIndexFour' to 'dumpIndexFour'.

    Now that we have successfully packed the OSRS indices into the RS2 Cache indices we are now ready to move on to replacing the 'Configs' in the RS2 Client with the OSRS ones we had dumped. For this we need to use the previously mentioned Tool by Chad Alan, 'RuneScape Asset Manager', please if you didn't already, download and then run the tool.

    Once open we need to load up our caches into the tool, you can do this by clicking the 'Load' button and then when prompted, navigate to the Clients './data/Cache' folder. This will then load our RS2 Cache into view.
    You will notice straight away that the indices of the Cache show up on the left.

    The first thing we will replace is the 'map_index' file we generated while dumping Index 4 from the OSRS cache using the 'osdc-gui.jar' program in Pt.1 of the guide. The map index belongs in an Archive called 'versionlist', to get there, firstly on the left hand side of the 'rsam-gui.jar' program - click 'Index 0 (Archive)' you will notice that the main part of the application fills up with a list of different archives found within the cache, Proceed to right-click 'versionlist' from that list and click 'Open' on the right-click menu.

    Once you click 'Open' a new window will appear on top of the application showing the versionlist archive on the left, click this to view inside it, this will show another list which contains the 'map_index' file we need to replace. To replace the file simply right-click on the file and choose 'replace' from the right-click menu shown - You will then be prompted to locate the file to replace it with, which can be found in the 'Data Dumping Pack/_CACHE/154u2/data' folder we made. Once replaced you can proceed to close the new window which was opened.
    That's how easy it is to replace data in the RS2 Cache. It's come a long way and knowledge of the RS2 has grown phenomenally since the early days of RSPS. Anyway now we need to replace the rest of our Dumped OSRS data with the RS2 versions. The 'map_index' file was the only part of the dumped data that was held in a different part of the cache than the rest of the data, now to find the other data we need to go back to where we started out.

    Click 'index 0 (archives)' again, but this time choose 'Config' and right-click to open this. There are a total of 10 files that need to be replaced in this archive. You will note the rest of the files that need replacing in the 'Data Dumping Pack/_CACHE/154u2/data' folder, these are: 'flo.dat', 'loc.idx/.dat', 'npc.idx/.dat', 'obj.idx/.dat', 'seq.dat', 'spotanim.dat' and 'varbit.dat'.

    Using the same method we used to replace the 'map_index' file please do the same with these 10 files. You may notice their are files contained in the archive which we don't have dumped, you do not need to worry about these extra files.
    Note: Make sure that you ONLY replace the files you intend to replace and do not replace say 'npc.dat' with 'npc.idx' this will mess you up and will not work out well for you. If you do mess up, please simply replace the replaced file with the correct one. (Please watch the gif below to see how to replace files which were switched with the wrong file.) If you feel you are beyond repair then please start again using the backup you made at the beginning.
    Note: You may also notice that one of the files are missing, I noticed for instance 'loc.idx' was missing, to add this Simply click the 'Add' button and add the file which is missing.

    And that is it! You have successfully packed OldSchool RuneScape data into RuneScape 2 - Give yourself a pat on the back. If your server loads data from the cache then you will need to copy the cache from the Clients data folder over to the Servers data folder.
    You can now run the Client, login and set your location to a place which was unavailable in RS2 or spawn Items/NPCs and Objects which are from the Latest revision of RuneScape.


    Thanks for reading, If you feel I have missed anything out then please post and let me know so I can amend the post!!
    - Ian

    Attached Files:

    #1 Ian, Sep 3, 2017
    Last edited: Sep 13, 2017
    • Informative Informative x 1
    • List
  2. thanks for this ian very useful