Difference between revisions of "How to package a Mini Micro game"
Jump to navigation
Jump to search
| (8 intermediate revisions by 2 users not shown) | |||
| Line 12: | Line 12: | ||
# Download the Windows distribution of Mini Micro from the [https://miniscript.org/MiniMicro/ official web page]. | # Download the Windows distribution of Mini Micro from the [https://miniscript.org/MiniMicro/ official web page]. | ||
# Put your '''user.minidisk''' file next to the '''Mini Micro.exe''' file. | # Put your '''user.minidisk''' file next to the '''Mini Micro.exe''' file. | ||
| − | # If you like, rename '''Mini Micro.exe''' to the name of your game. | + | # If desired, make a '''[[bootOpts.grfon]]''' file and place that in the '''Mini Micro_Data/StreamingAssets''' subfolder. |
| + | # If you like, rename '''Mini Micro.exe''' to the name of your game. Note: Do not forget to change the folder '''Mini Micro_data''' to the name change with the exe with '''_data'''. example: '''strat.exe''', data folder would be '''strat_data'''. | ||
# Zip up (or otherwise archive, as you prefer) the whole folder containing the .exe, your '''user.minidisk''' file, and everything else that came with the original Windows distribution. | # Zip up (or otherwise archive, as you prefer) the whole folder containing the .exe, your '''user.minidisk''' file, and everything else that came with the original Windows distribution. | ||
| Line 24: | Line 25: | ||
# Download the MacOS distribution of Mini Micro from the [https://miniscript.org/MiniMicro/ official web page]. | # Download the MacOS distribution of Mini Micro from the [https://miniscript.org/MiniMicro/ official web page]. | ||
# Put your '''user.minidisk''' file next to the '''MiniMicro.app''' file. (If you are doing this in Windows or Linux, '''MiniMicro.app''' will appear as a folder; on a Mac, the same folder appears as an app, and the .app extension may be hidden.) | # Put your '''user.minidisk''' file next to the '''MiniMicro.app''' file. (If you are doing this in Windows or Linux, '''MiniMicro.app''' will appear as a folder; on a Mac, the same folder appears as an app, and the .app extension may be hidden.) | ||
| + | # If desired, make a '''[[bootOpts.grfon]]''' file, and place that inside the application bundle under '''Contents/Resources/Data/StreamingAssets'''. | ||
# If you like, rename '''MiniMicro.app''' to the name of your game. | # If you like, rename '''MiniMicro.app''' to the name of your game. | ||
# Zip up (or place on a [https://support.apple.com/guide/disk-utility/create-a-disk-image-dskutl11888/mac disk image]) the whole folder containing the app and your '''user.minidisk''' file. | # Zip up (or place on a [https://support.apple.com/guide/disk-utility/create-a-disk-image-dskutl11888/mac disk image]) the whole folder containing the app and your '''user.minidisk''' file. | ||
| − | The resulting zip or DMG can then be uploaded to DropBox or itch.io, or otherwise distributed to your players. | + | The resulting zip or DMG can then be uploaded to DropBox or itch.io, or otherwise distributed to your players. But note that MacOS security (quarantine) may require your players to fix the le-resulting [[UnauthorizedAccessException]]. |
== Packaging for Linux Download == | == Packaging for Linux Download == | ||
| Line 36: | Line 38: | ||
# Download the Linux distribution of Mini Micro from the [https://miniscript.org/MiniMicro/ official web page]. | # Download the Linux distribution of Mini Micro from the [https://miniscript.org/MiniMicro/ official web page]. | ||
# Put your '''user.minidisk''' file next to the '''MiniMicro.x86_64''' file. | # Put your '''user.minidisk''' file next to the '''MiniMicro.x86_64''' file. | ||
| + | # If desired, make a '''[[bootOpts.grfon]]''' file and place that in the '''MiniMicro_Data/StreamingAssets''' folder. | ||
# If you like, rename '''MiniMicro.x86_64''' to the name of your game. | # If you like, rename '''MiniMicro.x86_64''' to the name of your game. | ||
# Zip up (or otherwise archive, as you prefer) the whole folder containing the executable, your '''user.minidisk''' file, and everything else that came with the original Linux distribution. | # Zip up (or otherwise archive, as you prefer) the whole folder containing the executable, your '''user.minidisk''' file, and everything else that came with the original Linux distribution. | ||
| Line 45: | Line 48: | ||
# Make a virtual disk containing just the files needed for your game or app. | # Make a virtual disk containing just the files needed for your game or app. | ||
# Add a [[startup.ms]] script that loads and runs your program. | # Add a [[startup.ms]] script that loads and runs your program. | ||
| − | # If your virtual disk is (in the real file system) a folder, zip | + | # If your virtual disk is (in the real file system) a folder, zip the contents of that folder. Rename the zip file exactly '''user.minidisk'''. |
# Download the WebGL Template from the [https://miniscript.org/MiniMicro/ official web page]. | # Download the WebGL Template from the [https://miniscript.org/MiniMicro/ official web page]. | ||
# Put your '''user.minidisk''' file into the '''StreamingAssets''' folder, replacing the (empty) user.minidisk there in the template. | # Put your '''user.minidisk''' file into the '''StreamingAssets''' folder, replacing the (empty) user.minidisk there in the template. | ||
| + | # If desired, make a '''[[bootOpts.grfon]]''' file and place that next to '''user.minidisk'''. | ||
# If uploading to itch.io, zip up the whole folder containing '''Build''', '''index.html''', and '''StreamingAssets'''. | # If uploading to itch.io, zip up the whole folder containing '''Build''', '''index.html''', and '''StreamingAssets'''. | ||
| − | # Upload that archive to itch.io, or upload the folder to your web site. If asked for | + | # Upload that archive to itch.io, or upload the folder to your web site. If asked for viewport dimensions, use 1024 by 768 pixels. |
[[Category:Mini Micro]] | [[Category:Mini Micro]] | ||
[[Category:How To]] | [[Category:How To]] | ||
Latest revision as of 03:18, 16 December 2022
To "package" a Mini Micro game means to bundle up all the files into a format that end-users can download (or access on the web) and play without needing anything else.
The basic idea is simple: Mini Micro will automatically look for a zip file (or folder) next to the executable called user.minidisk, and if it finds this, it would automatically mount that as /usr and run any program it finds there as /usr/startup.ms. So packaging amounts to taking a standard Mini Micro distribution, adding the desired user.minidisk file, and tweaking things like the app name and icon. Exact details, though, vary with the platform you're targeting.
Note that while the directions below include links to zip instructions/tools on the corresponding platform, it is not necessary to be on the platform you are packaging for. In other words, it should work perfectly well to package for all platforms, from whatever platform you happen to use. Also note that the first three steps in each section below are the same, and only need to be done once no matter how many platforms you package for.
Contents
Packaging for Windows Download
- Make a virtual disk containing just the files needed for your game or app.
- Add a startup.ms script that loads and runs your program.
- If your virtual disk is (in the real file system) a folder, zip it. Rename the zip file exactly user.minidisk.
- Download the Windows distribution of Mini Micro from the official web page.
- Put your user.minidisk file next to the Mini Micro.exe file.
- If desired, make a bootOpts.grfon file and place that in the Mini Micro_Data/StreamingAssets subfolder.
- If you like, rename Mini Micro.exe to the name of your game. Note: Do not forget to change the folder Mini Micro_data to the name change with the exe with _data. example: strat.exe, data folder would be strat_data.
- Zip up (or otherwise archive, as you prefer) the whole folder containing the .exe, your user.minidisk file, and everything else that came with the original Windows distribution.
The resulting archive file can then be uploaded to DropBox or itch.io, or otherwise distributed to your players.
Packaging for MacOS Download
- Make a virtual disk containing just the files needed for your game or app.
- Add a startup.ms script that loads and runs your program.
- If your virtual disk is (in the real file system) a folder, zip it. Rename the zip file exactly user.minidisk.
- Download the MacOS distribution of Mini Micro from the official web page.
- Put your user.minidisk file next to the MiniMicro.app file. (If you are doing this in Windows or Linux, MiniMicro.app will appear as a folder; on a Mac, the same folder appears as an app, and the .app extension may be hidden.)
- If desired, make a bootOpts.grfon file, and place that inside the application bundle under Contents/Resources/Data/StreamingAssets.
- If you like, rename MiniMicro.app to the name of your game.
- Zip up (or place on a disk image) the whole folder containing the app and your user.minidisk file.
The resulting zip or DMG can then be uploaded to DropBox or itch.io, or otherwise distributed to your players. But note that MacOS security (quarantine) may require your players to fix the le-resulting UnauthorizedAccessException.
Packaging for Linux Download
- Make a virtual disk containing just the files needed for your game or app.
- Add a startup.ms script that loads and runs your program.
- If your virtual disk is (in the real file system) a folder, zip it. Rename the zip file exactly user.minidisk.
- Download the Linux distribution of Mini Micro from the official web page.
- Put your user.minidisk file next to the MiniMicro.x86_64 file.
- If desired, make a bootOpts.grfon file and place that in the MiniMicro_Data/StreamingAssets folder.
- If you like, rename MiniMicro.x86_64 to the name of your game.
- Zip up (or otherwise archive, as you prefer) the whole folder containing the executable, your user.minidisk file, and everything else that came with the original Linux distribution.
The resulting archive file can then be uploaded to DropBox or itch.io, or otherwise distributed to your players.
Packaging for the Web
- Make a virtual disk containing just the files needed for your game or app.
- Add a startup.ms script that loads and runs your program.
- If your virtual disk is (in the real file system) a folder, zip the contents of that folder. Rename the zip file exactly user.minidisk.
- Download the WebGL Template from the official web page.
- Put your user.minidisk file into the StreamingAssets folder, replacing the (empty) user.minidisk there in the template.
- If desired, make a bootOpts.grfon file and place that next to user.minidisk.
- If uploading to itch.io, zip up the whole folder containing Build, index.html, and StreamingAssets.
- Upload that archive to itch.io, or upload the folder to your web site. If asked for viewport dimensions, use 1024 by 768 pixels.
