Skip to content

Commit

Permalink
Merge pull request #3 from asxrow66/main
Browse files Browse the repository at this point in the history
Did so much (check commits)
  • Loading branch information
jeremybosma authored Jun 18, 2024
2 parents 936403e + fd3628c commit 456050d
Show file tree
Hide file tree
Showing 22 changed files with 224 additions and 7 deletions.
5 changes: 5 additions & 0 deletions astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,18 @@ export default defineConfig({
title: 'Mythic Docs',
social: {
github: 'https://github.com/MythicApp/Mythic',
discord: 'https://discord.gg/GwHgX3QWK3',
},
sidebar: [
{
label: 'Getting Started',
items: [
// Each item here is one entry in the navigation menu.
{ label: 'Installation', link: '/guides/installation/' },
{ label: 'Setup', link: '/guides/setup'},
{ label: 'Navigating the Mythic UI', link: '/guides/nav'},
{ label: 'Installing Games', link: '/guides/gameinstall'},
{ label: 'Importing Games', link: '/guides/gameimport'},
],
},
{
Expand Down
Binary file added src/assets/maccounts.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/assets/mbottlesettings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/assets/mepicimport.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/assets/mgameinstall.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/assets/mgameset.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/assets/mhome.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/assets/minstallb.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/assets/mlibrary.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/assets/mlocalimport.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/assets/msettings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/assets/mstore.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/assets/msupport.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/assets/mversion.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/assets/mwine.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions src/content/docs/advoptions/bottlecreate.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,6 @@
title: Creating a bottle
---
### Video Guide
---
### Text Guide
The documentation is a ***work in progress***
35 changes: 35 additions & 0 deletions src/content/docs/guides/gameimport.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
title: Importing Games
---
# Video Guide
###### No video guide for this yet.
# Text Guide
### Epic Games Import
If you already have an Epic Games game downloaded (Windows or Mac) to your system, use this menu.
# <img alt="epicimport" src="../src/assets/mepicimport.png">
`Select a game:`, the game has to be inside of your Epic Games library, so, select the game you are importing.

`Choose the game's native platform:`, Mythic is not only a game launcher for Windows game but also a game launcher for Mac games as well, so if the game has a native port for Mac, you can select that here but you can also select Windows.

`Where is the game located?`, this is asking where the game is located, click on the `Browse` button to the right of this screen and locate the base game **folder** where the game is, inside of Finder.

`Import with DLCs`, if you have installed DLCs to the game you are importing, toggle this on so Mythic understands that and launches the game with them.

`Verify the game's integrity`, to make sure the files are up to date and haven't been deleted, created, or other tampers have been done to them, toggle this on so Mythic can compare the folder to what it knows.

When finished checking over this menu, press the `Done` button for Mythic to add this to your library and it can now be launched and played, using Mythic.

### Local Game Import
If you have another game, that isn't an Epic Games game, installed to your device such as a DRM-free, other launcher game, or a ~~pirated~~ game on your device, you can import it here.
# <img alt="localimport" src="../src/assets/mlocalimport.png">
On this menu, it is alike the Epic Games import window.

`What should we call this game?`, this is what Mythic will refer to the game as.

`Choose the game's native platform`, Mythic is not only a game launcher for Windows game but also a game launcher for Mac games as well, so if the game has a native port for Mac, you can select that here but you can also select Windows.

`Where is the game located`, this is asking where the game is located, click on the `Browse` button to the right of this screen and locate the base game **folder** where the game is, inside of Finder.

`Enter Thumbnail URL here... (optional)`, if you have the game's cover art image URL, you can paste it here so it appears like the other games that has custom cover art.

When finished checking over this menu, press the `Done` button for Mythic to add this to your library and it can now be launched and played, using Mythic.
22 changes: 22 additions & 0 deletions src/content/docs/guides/gameinstall.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: Installing Games
---
# Video Guide
##### This guide shows how to install games using Mythic.
[![How to Install and Setup Mythic](http://img.youtube.com/vi/AlYuxPeTnG8.jpg)](http://www.youtube.com/watch?v=AlYuxPeTnG8 "How to Install and Setup Mythic")
# Text Guide
Choose the game you want to install that is inside your Library.

Once you have chose the game you want to download, press the download button at the bottom of the cover art for that game.
# <img alt="installbutton" src="../src/assets/minstallb.png">
Once that is pressed, a menu will pop up for configurations about your download.
# <img alt="gameinstall" src="../src/assets/mgameinstall.png">
`Where do you want the game's base path to be located?`, if you are fine with the default path which is ~/Applications/Games/Mythic, your game get its own folder inside this directory.

`Choose the game's native platform`, Mythic is not only a game launcher for Windows game but also a game launcher for Mac games as well, so if the game has a native port for Mac, you can select that here but you can also select Windows.

`Install`, when finished configurating, press the purple `Install` button in the bottom right of the pop-up menu.

The game will now start download, you can check the progress of the download by pressing the `i` next to the progress bar on the game's cover art, or, you can proceed to the `Downloads` menu in the bottom left to see more info.

To cancel a download, press the `X` on the game's cover art or proceed to `Downloads` and press the `X` on the very right.
6 changes: 0 additions & 6 deletions src/content/docs/guides/gettingstarted.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,3 @@ title: Getting Started
description: Getting started with the basic features of Mythic and the installation.
---
A picture or video will be provided for reference on **some** parts of the documentation, not **all.**


title: Getting Started with Mythic
description: A guide in my new Starlight docs site.
---
### A video tutorial will be provided for some parts of the documentation.
138 changes: 138 additions & 0 deletions src/content/docs/guides/nav.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,138 @@
---
title: Navigating Mythic
---
#### No Video Guide
---
# Text Guide
## Home
# <img alt="Homepage" src="../src/assets/mhome.png">
Home appears when Mythic is launched.

It shows you your favorite games and all of your bottles. It also shows you your most recently played game.
## Library
# <img alt="Library" src="../src/assets/mlibrary.png">
The library shows all of your Epic Games games, if you decided to sign in, but it also shows your imported games if you've done that.
## Game Installation
# <img alt="gameinstallmenu" src="https://i.imgur.com/TA5vYS5.png">
This is just a **guide to the UI** of installing a game. To see how to install a game, go to Game Installation in the sidebar on the left.

Once you found an Epic Gams game to download, a menu will pop up.
On this page menu, there are 2 options you have.

`Where do you want the game's base path to be located?` which is where the game will be located, the default location is `~/Applications/Games/Mythic/[yourgamehere]`. You can either keep this to the default or change it to whatever folder or external drive you want it to be.

The next option is `Choose the game's native platform:` and Mythic is a game launcher for all platforms, not just Windows so if the game is a native Mac game, you can select that here but you can also download the Windows version.

## Game Importing
### Epic Games Import
# <img alt="gameimportmenu" src="../src/assets/mepicimport.png">
This is meant for Epic Games games that are already installed with apps such as Heroic Launcher or Whisky. This menu consists of many options.

`Select a game`, this is selecting the game that you are importing.

`Choose the game's native platform`, when the game is installed already, choose what platform the game is.

`Where is the game located`, choose where the game is located on your device or external drive so Mythic knows where to open it from.

`Import with DLCs`, if the game has installed DLCs, toggle this on so Mythic can have the DLCs in your imported game.

`Verify the game's integrity`, this is to make sure your imported game folder has all of the correct files to make sure the game isn't broken or missing dependencies.

### Local Game Import
# <img alt="localimport" src="../src/assets/mlocalimport.png">
This is meant for all other games that aren't from Epic Games, such as DRM-free platforms, other game launchers, and ~~pirated~~ games.

`What should we call this game?`, the name Mythic will use for this game.

`Choose the game's native platform:` as Mythic is a game launcher for MacOS and Windows, not just Windows, it needs to know what native platform it should run it as.

`Where is the game located?`, so Mythic knows where the game is located at.

`Enter thumbnail URL here... (optional)`, this is the cover art that will appear in your library and if this isn't filled it, it will use the icon of the imported game, most likely a folder icon.

## Game Settings
# <img alt="gamesettings" src="../src/assets/mgameset.png">
To change certain aspects or to manage parts of your game.
##### Options
`Thumbnail URL`, custom thumbnails for your games. Epic Games games already have a preset thumbnail.

`Launch Arguements`, to make games run a certain mod, mode, or change more aspects about your game.

`Verify File Integrity`, make sure your files are all there and aren't deleted, renamed, or tampered with.
##### File
`Move "Your Game Here"`, move where the game is located on your Mac.

`Show in Finder`, opens a Finder window of your game's directory.

##### Engine (Wine)
`Current Bottle`, change what bottle the selected game will open in.

`Performance HUD`, gives you information about how your game is running such as FPS and graphs.

`Retina Mode`, sharpens your game for better fidelity and makes it look more crisp and will make blurry resolutions look better.

`Enchanced Sync (MSync)`, improves FPS in more CPU-reliant games and boosts performance based to stock Wine.

`Windows Version`, very important option you have which can change the compatibility of some games and can be changed with no limit and the only downside would be your game being incompatibile with the version.
## Store
# <img alt="storefront" src="../src/assets/mstore.png">
The store, this is an embed of the Epic Games Store website where you can purchase games that are on the Epic Games Store and manage your account.
## Wine
# <img alt="wine" src="../src/assets/mwine.png">
The Wine menu shows all of your bottles and each bottle has its own settings and the option to be deleted.

## Bottle Settings
# <img alt="bottlesettings" src="../src/assets/mbottlesettings.png">
The bottle settings shows the settings for your bottle, obviously. In this menu you can toggle and change many settings about your bottle.

You can turn on the `Performance HUD` which gives you information about how your game is running such as FPS and graphs.

`Retina Mode` sharpens your game for better fidelity and makes it look more crisp and will make blurry resolutions look better.

You can also turn on `Enhanced Sync (MSync)` which improves FPS in more CPU-reliant games and boosts performance based to stock Wine.

The last option is your `Windows Version`, this is a very important option you have which can change the compatibility of some games and can be changed with no limit and the only downside would be your game being incompatibile with the version.

At the bottom of this menu, you have 4 options, `Open...`, `Launch Winetricks`, `Launch Configurator`, and `Launch Registry Editor`.

The `Open...` button allows you to open an `.exe` file which this button would most likely be used for portable apps or application setup files such as `SteamSetup.exe` or `UbisoftConnectInstaller.exe` and wouldn't need to be imported and could be opened from here.

The `Launch Winetricks` button is a work in progress but will maximize the compatibility for many apps and games.

The `Launch Configurator` button opens up a window to change many more options about your bottle, such as, Drives, Audio, and Graphics.

The `Launch Registry Editor` button allows you to change keys on your Windows bottle. Do NOT mess with anything in here unless you absolutely know what you're doing.

## Settings
# <img alt="settings" src="../src/assets/msettings.png">
#### Mythic
`Display Mythic activity status on Discord`, this toggles Mythic activity status displaying on your Discord profile.

`Minimize to menu bar on game launch`, this minimizes the Mythic window to the dock when a game is launched.

`Force quit all games when Mythic closes`, when Mythic is quit, all games opened with Mythic, will close.

`Choose the default base path for games:`, you can configure the directory where Mythic installs games at.

`Reset Mythic`, this resets the Mythic app to when you first installed it.

`Reset settings to default`, this resets the settings on this screen to the defaults.

#### Wine/Mythic Engine
`Force Quit All Windows Applications`, this forcefully quits all Windows apps and games open.

`Purge Shader Cache`, this can free up space on your device and help with game issues such as freezes, slow loads, and connectivity problems.

`Remove Mythic Engine`, removes the Mythic Engine from your device.

#### Epic
`Clean Up Miscellaneous Caches`, this cleans up and deletes caches made by Epic Games.

## Support
This displays 2 ways you can get support with Mythic, Discord and Patreon.
# <img alt="support" src="../src/assets/msupport.png">

## Accounts
This shows the Epic Games and Steam (when released) accounts connected to Mythic
# <img alt="accounts" src="../src/assets/maccounts.png">
It shows the account name connected to the Epic and/or Steam account and then on the right, you can unlink the account from Mythic.
20 changes: 20 additions & 0 deletions src/content/docs/guides/setup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
title: Setting Up Mythic
---
# Video Guide
###### This includes the installation of Mythic as well.

[![How to Install and Setup Mythic](http://img.youtube.com/vi/8OD3i1V2kIk/0.jpg)](http://www.youtube.com/watch?v=8OD3i1V2kIk "How to Install and Setup Mythic")
---
# Text Guide
Once Mythic is launched, as we did in the previous steps, press the arrow to continue

When Mythic opens your browser, sign into Epic Games and locate the `"authorizationCode":"[yourauthcode]` and copy it to your clipboard and then paste it into the text area in Mythic.

When continuing, it should welcome your Epic Games account name and then it will want you to Install the Mythic Engine, press the very left arrow.

It will then download and install, and then it will setup the default bottle that Mythic will use.

When it's finished, it will say "You're all set" and then press the arrow to continue.

Mythic has now set up and games can be downloaded.
2 changes: 1 addition & 1 deletion src/content/docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ hero:
file: ../../assets/mythic.png
actions:
- text: Getting Started
link: /guides/gettingstarted/
link: /guides/installation/
icon: right-arrow
variant: primary
- text: Already know? Install Mythic here
Expand Down

0 comments on commit 456050d

Please sign in to comment.