Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
EmeraldLoc authored May 12, 2023
1 parent 236c953 commit 62ef61f
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,35 +5,37 @@
I am a swift programmer who enjoys playing video games. I started when I was very young, and since then have learned the swift programming language, and I have loved it ever since I started programming in swift. I also program in lua, c#, am decent at c, and have done a little bit of js.

## How this project got started
Super Mario 64 was one of the first of 3 games I played, however I forgot about it for a couple of years until I learned about decomp and the sm64 pc port. Ever since I heard about it, I wanted to play the game in what was promised to be a wonderful 60fps, however with no easy way to do it, I realized I would have to make my own way. So after collecting a lot of knowledge about c and Makefiles and compilers, I was able to tinker up a small, but usable app, I then released the first version of sm_osx. Only including a couple of repos, it was the start of this project.
Super Mario 64 was one of the first of 3 games I played, however I forgot about it for a couple of years until I learned about decomp and the sm64 pc port. Ever since I heard about it, I wanted to play the game at 60fps widescreen, however, on my mac, with no easy way to do it, I realized I would have to make my own way. So after collecting a lot of knowledge about Makefiles and a bit about compilers, I was able to tinker up a small, but usable app. I then released the first version of sm_osx. Only including a couple of repos, it was the start of this project.

## Getting started
You can download sm_osx [here](https://github.com/EmeraldLoc/sm_osx/releases/latest/download/sm_osx.zip).

Homebrew will also be needed, you can follow the install instructions [here](https://brew.sh).
Note: while sm_osx should install homebrew for you, you will need to enter your password once if your on intel, and twice if your on arm.

## Faq
## FAQ
### What is sm_osx
sm_osx is a launcher and compiler for the Super Mario 64 Pc Port.
### Is sm_osx completly free
Yes, sm_osx is, and always will be, completly free.
### How can I get sm_osx
Go to the Getting Started section of this page.
### I quit the terminal popup during setup, now the app won't progress, what do I do?
Just restart the app, and the terminal window should reopen
### How do I update
There is a auto updater in sm_osx, so if an update comes out, you will be alerted.
### It says I need to select a rom, where can I get one?
You will need a nintendo 64 and a super mario 64 cartridge, from there, look up how to dump games from an n64.
There are many tutorials on how to get a super mario 64 rom, I would search "Dump rom n64" and find a legal way to dump any nintendo 64 rom.
### I have a rom, but it is not accepting it
Make sure the format is .z64, if it is .n64, you can use the byteswapper [here](https://hack64.net/tools/swapper.php).
Make sure the format is .z64, if it's .n64, you can use the byteswapper [here](https://hack64.net/tools/swapper.php).

If it's still failing, try renaming the file to something simple, if its still broken, please make a issue.
### The repos are failing to compile
Make sure you have Homebrew installed, if it is, please make an issue and send the log created.
### Where are the repos stored
The repos are stored in a folder called SM64Repos in your home folder.
### I have compiled a repo manually from source, but it does not compile with sm_osx
Make sure you have Homebrew installed, if it is installed, please make an issue and send the log created.
Please make an issue and send the log created so I can see about fixing it.
### I downloaded sm_osx, but it crashes on bootup
Please create an issue in the Issues page.
### My notifications are not working
Make sure you accepted them. You can check in the *Notifications* section in the System Settings App, find sm_osx, and turn notifications on.
Make sure you accepted them. You can check in the *Notifications* section in the System Settings app, or System Preferences app, find sm_osx, and turn notifications on.

0 comments on commit 62ef61f

Please sign in to comment.