Implement #5909: Import mp.dat from RCT1 installation #6078

Keatzee · 2017-07-30T22:15:45Z

I mostly work high-level so I'm not too good with pointers and memory yet, but hopefully I did this right! If not, please let me know how I can fix it.

~~Keep in mind that this won't work automatically for Steam's RCT1 version until #6028 is committed, as mp.dat is not in the Data directory by default.~~ Addressed in this PR.

rwjuk · 2017-07-30T22:23:55Z

src/openrct2/scenario/ScenarioRepository.cpp

+            auto mpdat = (uint8 *)(File::ReadAllBytes(mpdatPath, &length));
+            auto outFS = FileStream(sc21Path, FILE_MODE_WRITE);
+
+            for (int i = 0; i < (int)length; i++)


Use explicit types - e.g. uint32 (unsigned as the length can't be negative).

rwjuk · 2017-07-30T22:32:55Z

src/openrct2/scenario/ScenarioRepository.cpp

        Scan(rct1dir);
        Scan(rct2dir);
        Scan(openrct2dir);
+        ScanMegaPark(rct1datdir, rct1dir);


Unsure as to whether we should put the decoded SC4 in the RCT1 dir, or keep it in the user's OpenRCT2 scenarios folder. We don't usually modify the source directories, but then again we're not doing anything that the original game didn't do here.

On my machine, the RCT1 and RCT2 install directories are read-only protected so this would fail.

@IntelOrca Yeah, that's exactly the scenario I was wondering about.

@Keatzee Can you change rct1dir to openrct2dir here?

Anything created through OpenRCT2 I think should not extend past OpenRCT2's directories.

My OpenRCT2 directory doesn't have a scenario folder, so it threw an exception. It works once you add a scenario folder, but shouldn't it do that by default?

I believe they're created on demand - you'll need to check for existence, and if the check fails, create the dir.

rwjuk · 2017-07-30T23:12:25Z

src/openrct2/scenario/ScenarioRepository.cpp

@@ -285,6 +285,7 @@ class ScenarioRepository final : public IScenarioRepository
        Path::Append(mpdatPath, sizeof(mpdatPath), "mp.dat");

        String::Set(sc21Path, sizeof(sc21Path), scenarioDir.c_str());
+        platform_ensure_directory_exists(sc21Path); //Ensure the scenario directory exists first


Comments should go above the line they're referring to (see style guide here).

rwjuk · 2017-07-30T23:13:36Z

Apart from the minor line note, this should get a changelog entry. The code looks good to me, and works as expected.

janisozaur · 2017-07-31T05:27:32Z

src/openrct2/scenario/ScenarioRepository.cpp

+                //Rotate each byte left by 4 bits to convert
+                byte = *(mpdat + i);
+                byte = rol8(byte, 4); 
+                outFS.Write(&byte, sizeof(byte));


This would be very inefficient, it would be better to read all the data into memory, rol8 it and only then write it all.

janisozaur · 2017-07-31T15:07:25Z

src/openrct2/scenario/ScenarioRepository.cpp

+        if (platform_file_exists(mpdatPath) && !(platform_file_exists(sc21Path)))
+        {
+            size_t length;
+            auto mpdat = (uint8 *)(File::ReadAllBytes(mpdatPath, &length));


That looks a little fishy to me. Why does it have to be casted? The other thing is it looks like leaked memory to me.

I thought void pointers have to be casted before you can do anything with them... What would you suggest instead?

Oh, File::ReadAllBytes returns void *. I'd say that's a bit odd, given the name of this function (Bytes) and I would've expected it to return uint8 * already. @IntelOrca ?

You should probably call Memory::FreeArray on that pointer once done with it.

janisozaur · 2017-07-31T16:34:55Z

distribution/changelog.txt

@@ -1,4 +1,4 @@
-0.1.1 (in development)
+0.1.1 (in development)


Please remove this change

janisozaur

I left some minor comments to address.

janisozaur · 2017-08-02T05:55:19Z

src/openrct2/PlatformEnvironment.cpp

@@ -183,6 +188,7 @@ const char * PlatformEnvironment::FileNames[] =
    "hotkeys.dat",          // CONFIG_KEYBOARD
    "objects.idx",          // CACHE_OBJECTS
    "tracks.idx",           // CACHE_TRACKS
+    "RCTdeluxe_install" PATH_SEPARATOR "Data" PATH_SEPARATOR "mp.dat", // MP.DAT (Steam RCT1 ONLY)


You mention this file by two distinct names here: mp.dat and MP.DAT. SteamDB says it's mp.dat, please update the comment accordingly.

On second thought, I think it should be MP_DAT because that's what defined in PATHID emum in PlatformEnvironment.h. That way it's consistent with the other comments

janisozaur · 2017-08-02T05:57:05Z

src/openrct2/scenario/ScenarioRepository.cpp

        Scan(rct1dir);
        Scan(rct2dir);
        Scan(openrct2dir);
+        ScanMegaPark(mpdatdir, openrct2dir);


It does much more than just Scan a directory, I don't think that's an appropriate name for this method.

janisozaur · 2017-08-02T05:58:25Z

src/openrct2/scenario/ScenarioRepository.cpp

@@ -272,6 +275,36 @@ class ScenarioRepository final : public IScenarioRepository
        delete scanner;
    }

+    void ScanMegaPark(std::string &mpdatDir, std::string &scenarioDir)
+    {
+        //Convert mp.dat from RCT1 Data directory into SC21.sc4 (Mega Park)


SC21.sc4 vs SC21.SC4 below. Please chose one.

janisozaur · 2017-08-02T06:02:18Z

src/openrct2/scenario/ScenarioRepository.cpp

+
+        String::Set(sc21Path, sizeof(sc21Path), scenarioDir.c_str());
+        //Ensure the scenario directory exists first
+        platform_ensure_directory_exists(sc21Path); 


This call should only take place if we find mp.dat and have something to convert.

rwjuk · 2017-08-10T11:46:41Z

@Keatzee Could you rebase this please?

Gymnasiast · 2017-08-11T19:43:17Z

src/openrct2/PlatformEnvironment.cpp

@@ -182,6 +186,7 @@ const char * PlatformEnvironment::FileNames[] =
    "hotkeys.dat",          // CONFIG_KEYBOARD
    "objects.idx",          // CACHE_OBJECTS
    "tracks.idx",           // CACHE_TRACKS
+    "RCTdeluxe_install" PATH_SEPARATOR "Data" PATH_SEPARATOR "mp.dat", // MP_DAT


This looks suspicious to me. Has this actually been tested on non-Deluxe versions?

I think you're right - I forgot to re-add the check for non-Steam versions while changing a bunch of stuff. I'll fix it tomorrow.

Gymnasiast · 2017-08-11T19:49:17Z

I'd rather have seen this not merged until I got home. I don't think this was properly tested, as none of you (except Ted) has RCT1, much less have it installed.

rwjuk · 2017-08-12T10:19:13Z

@Gymnasiast I do, and it worked with my RCT1 path (C:\Users\<username>\RCT\RCT1) when I tested it. Evidently PlatformEnvironment.cpp was modified after I tested.

- Feature: [#2893] Object selection filters for items from RCT1, Added Attractions and Loopy Landscapes. - Feature: [#3505] Allow up to 1024 items per scenery tab. - Feature: [#3510] Auto-append extension if none is specified. - Feature: [#3994] Show bottom toolbar with map tooltip (theme option). - Feature: [#4184] Add command and cheat to alter the date. - Feature: [#4906] Add follow sprite command to title sequences. - Feature: [#4984] Add option to highlight path issues: full bins, vandalism & vomit. - Feature: [#5826] Add the show_limits command to show map data counts and limits. - Feature: [#6078] Game now converts mp.dat to SC21.SC4 (Mega Park) automatically. - Feature: [#6125] Path can now be placed in park entrances. - Feature: [#6181] Map generator now allows adjusting random terrain and tree placement in Simplex Noise tab. - Feature: [#6235] Add drawing debug option for showing visuals when and where blocks of the screen are painted. - Feature: [#6290] Arabic translation (experimental). - Feature: [#6292] Allow building queue lines in the Scenario Editor. - Feature: [#6295] TrueType fonts are now rendered with light font hinting by default. - Feature: [#6307] Arrows are now shown when placing park entrances. - Feature: [#6313] Add keyboard shortcut for toggle gridlines. - Feature: [#6324] Add command to deselect unused objects from the object selection. - Feature: [#6325] Allow using g1.dat from RCT Classic. - Feature: [#6329] Render level crossings when the Miniature Railway crossed a path. - Feature: [#6338] Virtual floor to help positioning objects vertically. - Feature: [#6353] Show custom RCT1 scenarios in New Scenario window. - Feature: [#6411] Add command to remove the park fence. - Feature: [#6414] Raise maximum launch speed of the Corkscrew RC back to 96 km/h (for RCT1 parity). - Feature: [#6433] Turn 'unlock all prices' into a regular (non-cheat, persistent) option. - Feature: [#6516] Ability to search by filename in the object selection window. - Feature: [#6530] Land rights tool no longer blocks when a tile is not for purchase. - Feature: [#6568] Add smooth nearest neighbour scaling. - Feature: [#6651, #6658] Integrate Discord Rich Presence. - Feature: [#6709] The New Ride window now shows available vehicles for a ride type. - Feature: [#6731] Object indexing progress is now reported via command line output. - Feature: [#6779] On-ride photo segment for Splash Boats. - Feature: [#6838] Ability to auto-pause server when no clients are connected. - Feature: [#7031] Better support for displaced ride entrances and exits. - Feature: Add search box to track design window. - Feature: Allow using object files from RCT Classic. - Feature: Title sequences now testable in-game. - Feature: Vehicles with matching capabilities are now always switchable. - Feature: Add search box to track design window. - Feature: Add load scenario command to title sequences. - Fix: [#816] In the map window, there are more peeps flickering than there are selected (original bug). - Fix: [#996, #2589, #2875] Viewport scrolling no longer shakes or gets stuck. - Fix: [#1185] Close button colour of prompt windows does not match. - Fix: [#1833, #4937, #6138] 'Too low!' warning when building rides and shops on the lowest land level (original bug). - Fix: [#2254] Edge scrolling horizontally now has the same speed as vertical edge scrolling. - Fix: [#2607] Rain rendered incorrectly in additional viewport. - Fix: [#3171] Guests entering from the corner of the tile in Amity Airfield (original bug). - Fix: [#3330] Current number of passengers overflows when over 255 (original bug). - Fix: [#4760] Asia - Great Wall of China and South America - Rio Carnival have incorrect guest entry points (original bug). - Fix: [#4953, #6277] Unable to advertise to master servers over IPv6. - Fix: [#4991] Inverted helices can be built on the Lay Down RC, but are not drawn. - Fix: [#5190] Cannot build Wild Mouse - Flying Dutchman Gold Mine. - Fix: [#5224] Multiplayer window is not closed when server shuts down. - Fix: [#5228] Top toolbar disappears when opening SC4 file. - Fix: [#5261] Deleting a banner sign after copy/pasting it will crash the game. - Fix: [#5398] Attempting to place Mini Maze.TD4 results in weird behaviour and crashes. - Fix: [#5417] Hacked Crooked House tracked rides do not dispatch vehicles. - Fix: [#5445] Patrol area not imported from RCT1 saves and scenarios. - Fix: [#5585] Inconsistent zooming with mouse wheel. - Fix: [#5609] Vehicle switching may cause '0 cars per train' to be set. - Fix: [#5636] Pausing the game shows mute button as active. - Fix: [#5741] Land rights indicators disappear when switching views. - Fix: [#5761] Mini coaster doesn't appear despite being selected. - Fix: [#5788] Empty scenario names cause invisible entries in scenario list. - Fix: [#5809] Support Steam RCT1 file layout when loading CSG images. - Fix: [#5838] Crash when saving very large track designs. - Fix: [#5901] Placing peep spawn not synced across multiplayer. - Fix: [#6101] Rides remain in ride list window briefly after demolition. - Fix: [#6114] Crash when using a non-LL CSG1.DAT. - Fix: [#6115] Random title screen music not random on launch. - Fix: [#6118, #6245, #6366] Tracked animated vehicles not animating. - Fix: [#6129] Guest List summary not updating after a ride rename. - Fix: [#6133] Construction rights not shown after selecting buy mode. - Fix: [#6188] Viewports not being clipped properly when zoomed out in OpenGL mode. - Fix: [#6193] All rings in Space Rings use the same secondary colour. - Fix: [#6196, #6223] Guest's energy underflows and never decreases. - Fix: [#6198] You cannot cancel RCT1 directory selection. - Fix: [#6199] Inverted Hairpin Coaster vehicle tab is not centred. - Fix: [#6202] Guests can break occupied benches (original bug). - Fix: [#6251] Splash Boats renders flat-to-25-degree pieces in tunnels incorrectly. - Fix: [#6261, #6344, #6520] Broken pathfinding after removing park entrances with the tile inspector. - Fix: [#6271] Wrong booster speed tooltip text. - Fix: [#6293] Restored interface sounds while gameplay is paused. - Fix: [#6301] Track list freezes after deleting track in Track Manager. - Fix: [#6308] Cannot create title sequence if title sequences folder does not exist. - Fix: [#6314] Imported SV4 files do not mark their scenarios as completed. - Fix: [#6318] Cannot sack staff that have not been placed. - Fix: [#6320] Crash when CSS1.DAT is absent. - Fix: [#6331] Scenery costs nothing in track designs. - Fix: [#6358] HTTP requests can point to invalid URL string. - Fix: [#6360] Off-by-one filenames when exporting all sprites. - Fix: [#6388] Construction rights tool erroneously enabled in some RCT1 scenarios even when no rights are available. - Fix: [#6413] Maze previews only showing scenery. - Fix: [#6423] Importing parks containing names with Polish characters. - Fix: [#6423] Polish characters now correctly drawn when using the sprite font. - Fix: [#6445] Guests' favourite ride improperly set when importing from RCT1 or AA. - Fix: [#6452] Scenario text cut off when switching between 32 and 64-bit builds. - Fix: [#6460] Crash when reading corrupt object files. - Fix: [#6481] Can't take screenshots of parks with colons in the name. - Fix: [#6500] Failure to load resources when config file is missing. - Fix: [#6547] The server log is not logged if the server name contains CJK. - Fix: [#6593] Cannot hire entertainers when default scenery groups are not selected (original bug). - Fix: [#6657] Guest list is missing tracking icon after reopening. - Fix: [#6803] Symbolic links to directories are not descended by FileScanner. - Fix: [#6830] Crash when using mountain tool due to ride with no ride entry. - Fix: [#6833] Shops in corrupted files not imported correctly. - Fix: [#6846] Zoom level in some ride overview windows was erroneously set too high. - Fix: [#6904] Manually added multiplayer servers not saved. - Fix: [#7003] Building sloped paths through flat paths with clearance checks off causes glitches. - Fix: [#7011] Swinging and bobsleigh cars going backwards swing in the wrong direction (original bug). - Fix: [#7042, #7077] Paths sometimes disconnect when building them with clearance checks off. - Fix: [#7125] No entry signs not correctly handled in pathfinding. - Fix: [#7223] Vehicle mass not correctly recalculated when using remove all guests cheat. - Fix: [#7229] Exploding guests cheat causes rides to get stuck and freezes game. - Fix: [#7295] peep_should_go_on_ride_again() checked balloon colour instead of toilet need. - Fix: [#7301] Sprite compiler dithering checks transparency of wrong pixel. - Fix: Infinite loop when removing scenery elements with >127 base height. - Fix: Ghosting of transparent map elements when the viewport is moved in OpenGL mode. - Fix: Clear IME buffer after committing composed text. - Fix: RCT1 mazes with wooden fences not imported correctly. - Fix: Title sequence editor now gracefully fails to preview a title sequence and lets the user know with an error message. - Fix: When preset title sequence fails to load, the preset will forcibly be changed to the first sequence to successfully load. - Fix: Remove consecutive thoughts about a ride being demolished. - Fix: Water raft vehicles stop spinning when going up slopes. - Fix: Incorrect spin is applied to coasters on S-bends and other turns. - Improved: [#5962] Use AVX2 instruction set where supported, resulting in a performance boost. - Improved: [#5964] Use SSE 4.1 instruction set where supported, resulting in a performance boost. - Improved: [#6186] Transparent menu items now draw properly in OpenGL mode. - Improved: [#6218] Speed up game start up time by saving scenario index to file. - Improved: [#6242] Prevent scenery aging and grass growth causing tile invalidation unless necessary - slight performance boost. - Improved: [#6423] Polish is now rendered using the sprite font, rather than TTF. - Improved: [#6746] Draw friction wheels instead of chain lift on Looping Roller Coaster stations. - Improved: Load/save window now refreshes list if native file dialog is closed/cancelled. - Improved: Major translation updates for Japanese and Polish. - Improved: Added 24x24, 48x48, and 96x96 icon resolutions. - Technical: [#6384] On macOS, address NSFileHandlingPanel deprecation by using NSModalResponse instead. - Technical: [#6772] RCT2 interop removed.

rwjuk suggested changes Jul 30, 2017

View reviewed changes

rwjuk reviewed Jul 30, 2017

View reviewed changes

janisozaur reviewed Jul 31, 2017

View reviewed changes

distribution/changelog.txt Outdated

@@ -1,4 +1,4 @@

0.1.1 (in development)

0.1.1 (in development)

Copy link

Member

janisozaur Jul 31, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please remove this change

IntelOrca added this to the v0.1.2 milestone Jul 31, 2017

rwjuk approved these changes Aug 1, 2017

View reviewed changes

janisozaur requested changes Aug 2, 2017

View reviewed changes

janisozaur approved these changes Aug 3, 2017

View reviewed changes

janisozaur added the pending rebase PR needs to be rebased. label Aug 10, 2017

Resolve OpenRCT2#5909: Import mp.dat from RCT1 installation

c0ad8f9

janisozaur force-pushed the mpdat-convert branch from 93b8de6 to c0ad8f9 Compare August 10, 2017 18:33

janisozaur removed the pending rebase PR needs to be rebased. label Aug 10, 2017

janisozaur merged commit 96a3f6a into OpenRCT2:develop Aug 10, 2017

Gymnasiast reviewed Aug 11, 2017

View reviewed changes

Keatzee mentioned this pull request Aug 13, 2017

Add #5809: Support Steam RCT1 file layout #6173

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement #5909: Import mp.dat from RCT1 installation #6078

Implement #5909: Import mp.dat from RCT1 installation #6078

Keatzee commented Jul 30, 2017 •

edited

rwjuk Jul 30, 2017

rwjuk Jul 30, 2017

IntelOrca Jul 30, 2017 •

edited

rwjuk Jul 30, 2017

CharlesLove Jul 30, 2017

Keatzee Jul 30, 2017 •

edited

rwjuk Jul 30, 2017

rwjuk Jul 30, 2017

rwjuk commented Jul 30, 2017

janisozaur Jul 31, 2017

janisozaur Jul 31, 2017

Keatzee Jul 31, 2017

janisozaur Jul 31, 2017

janisozaur Jul 31, 2017

janisozaur left a comment

janisozaur Aug 2, 2017

Keatzee Aug 2, 2017

janisozaur Aug 2, 2017

janisozaur Aug 2, 2017

janisozaur Aug 2, 2017

rwjuk commented Aug 10, 2017

Gymnasiast Aug 11, 2017

Keatzee Aug 12, 2017

Gymnasiast commented Aug 11, 2017

rwjuk commented Aug 12, 2017

Implement #5909: Import mp.dat from RCT1 installation #6078

Implement #5909: Import mp.dat from RCT1 installation #6078

Conversation

Keatzee commented Jul 30, 2017 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

IntelOrca Jul 30, 2017 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Keatzee Jul 30, 2017 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rwjuk commented Jul 30, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

janisozaur left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rwjuk commented Aug 10, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Gymnasiast commented Aug 11, 2017

rwjuk commented Aug 12, 2017

Keatzee commented Jul 30, 2017 •

edited

IntelOrca Jul 30, 2017 •

edited

Keatzee Jul 30, 2017 •

edited