Skip to content

Commit 330be9a

Browse files
authored
Merge pull request #921 from PlayEveryWare/fix/doc-links
Fix Documentation Links
2 parents ee85d40 + 6b960f1 commit 330be9a

28 files changed

+47
-47
lines changed

.github/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<a href="/readme.md"><img src="/com.playeveryware.eos/Documentation~/images/PlayEveryWareLogo.gif" alt="Lobby Screenshot" width="5%"/></a>
1+
<a href="/README.md"><img src="/com.playeveryware.eos/Documentation~/images/PlayEveryWareLogo.gif" alt="Lobby Screenshot" width="5%"/></a>
22

33
<div align="center"> <img src="/com.playeveryware.eos/Documentation~/images/EOSPluginLogo.png" alt="PlayEveryWare EOS Plugin for Unity" /> </div>
44

com.playeveryware.eos/Documentation~/android/README_Android.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
<a href="/README.md"><img src="/docs/images/PlayEveryWareLogo.gif" alt="Lobby Screenshot" width="5%"/></a>
1+
<a href="/README.md"><img src="/com.playeveryware.eos/Documentation~/images/PlayEveryWareLogo.gif" alt="Lobby Screenshot" width="5%"/></a>
22

3-
<div align="center"> <img src="/docs/images/EOSPluginLogo.png" alt="PlayEveryWare EOS Plugin for Unity" /> </div>
3+
<div align="center"> <img src="/com.playeveryware.eos/Documentation~/images/EOSPluginLogo.png" alt="PlayEveryWare EOS Plugin for Unity" /> </div>
44

55
# <div align="center">Android</div>
66
---
@@ -52,7 +52,7 @@ You can follow the standard <a href="/README.md#configuring-the-plugin">Configur
5252
5353
3. Update the <a href="https://docs.unity3d.com/2021.3/Documentation/Manual/class-PlayerSettingsAndroid.html">Minimum API Level</a> to be at least ```Android 6.0 'Marshmallow' (API Level 23)```.
5454

55-
4. Optionally, set the plugin to <a href="/docs/android/link_eos_library_settings.md">link the EOS Library dynamically</a>.
55+
4. Optionally, set the plugin to <a href="link_eos_library_settings.md">link the EOS Library dynamically</a>.
5656

5757

5858
# FAQ

com.playeveryware.eos/Documentation~/android/environment_setup_android.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<a href="/README.md"><img src="/docs/images/PlayEveryWareLogo.gif" alt="Lobby Screenshot" width="5%"/></a>
1+
<a href="/README.md"><img src="/com.playeveryware.eos/Documentation~/images/PlayEveryWareLogo.gif" alt="Lobby Screenshot" width="5%"/></a>
22

33
# <div align="center">Environment Setup for Android</div>
44
---
@@ -9,7 +9,7 @@
99

1010
2. Open the "Add modules" window.
1111

12-
<img src="/docs/images/unity_add_modules.png" width="500" />
12+
<img src="/com.playeveryware.eos/Documentation~/images/unity_add_modules.png" width="500" />
1313

1414
2. Select and install the following modules:
1515

@@ -30,7 +30,7 @@ The following methods will show how to install the missing build-tool 30.0.3, an
3030
1. [Install Android Studio](https://developer.android.com/studio)
3131
2. Run the SDK Manager
3232

33-
<img src="/docs/images/android_studio_sdk_manager.png" width="500" />
33+
<img src="/com.playeveryware.eos/Documentation~/images/android_studio_sdk_manager.png" width="500" />
3434

3535
### Manage SDK through command prompt
3636

com.playeveryware.eos/Documentation~/android/link_eos_library_settings.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<a href="/README.md"><img src="/docs/images/PlayEveryWareLogo.gif" alt="Lobby Screenshot" width="5%"/></a>
1+
<a href="/README.md"><img src="/com.playeveryware.eos/Documentation~/images/PlayEveryWareLogo.gif" alt="Lobby Screenshot" width="5%"/></a>
22

33
# <div align="center">Linking EOS Library on Android Settings</div>
44
---

com.playeveryware.eos/Documentation~/contributions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ See [standards.md](/com.playeveryware.eos/Documentation~/standards.md).
6161
6262
## Unit Testing
6363
64-
See [our documentation on unit testing](/com.playeveryware.eos/Documentation~/unit-testing.md).
64+
See [our documentation on unit testing](/com.playeveryware.eos/Documentation~/unit_testing.md).
6565
6666
## Core Classes
6767

com.playeveryware.eos/Documentation~/dev_env/HyperV_Linux_Guest_VM.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<a href="/README.md"><img src="/docs/images/PlayEveryWareLogo.gif" alt="README.md" width="5%"/></a>
1+
<a href="/README.md"><img src="/com.playeveryware.eos/Documentation~/images/PlayEveryWareLogo.gif" alt="README.md" width="5%"/></a>
22

33
# <div align="center">Setting up a Hyper-V Linux Guest VM</div>
44
---
@@ -14,17 +14,17 @@ This document describes how to create a Ubuntu Virtual Machine on Hyper-V suitab
1414
> [!NOTE]
1515
> The follow screenshots are taken in Windows 11, so if you are running Windows 10 yours might look a little differently.
1616
17-
<img src="/docs/images/hyperv_linux_guest_vm/windows-features-search.png" width="350" />
17+
<img src="/com.playeveryware.eos/Documentation~/images/hyperv_linux_guest_vm/windows-features-search.png" width="350" />
1818

1919
2. Make sure you select all of the options below.
2020

21-
<img src="/docs/images/hyperv_linux_guest_vm/windows-features-on-off.png" width="400" />
21+
<img src="/com.playeveryware.eos/Documentation~/images/hyperv_linux_guest_vm/windows-features-on-off.png" width="400" />
2222

2323
If these options are greyed out, you may need to enter your bios settings to enable virtualization. See the following guide for general instructions on how to accomplish this: [How to Enable CPU Virtualization in Your Computer BIOS](https://www.bleepingcomputer.com/tutorials/how-to-enable-cpu-virtualization-in-your-computer-bios/).
2424

2525
You can also tell if Virtualization is enabled in your BIOS by looking at the CPU Performance tab in Task Manager.
2626

27-
<img src="/docs/images/hyperv_linux_guest_vm/task-manager-virtualization-check.png" width="500" />
27+
<img src="/com.playeveryware.eos/Documentation~/images/hyperv_linux_guest_vm/task-manager-virtualization-check.png" width="500" />
2828

2929
If it says "Disabled" instead of "Enabled," (like it does here) you will need to enable it in your BIOS.
3030

@@ -36,14 +36,14 @@ Setting up network configuration can be a little bit confusing if you're doing i
3636

3737
1. After restarting your computer, open the Hyper-V Manager, and configure the network by opening the "Virtual Switch Manager..." in the right-hand "Actions" bar.
3838

39-
<img src="/docs/images/hyperv_linux_guest_vm/virtual-switch-manager.png" width="150" />
39+
<img src="/com.playeveryware.eos/Documentation~/images/hyperv_linux_guest_vm/virtual-switch-manager.png" width="150" />
4040

4141
2. If there _isn't_ **already** a "Default Switch" listed in the Virtual Switch Manager, go ahead and select "External," and "Create Virtual Switch," naming the switch "Default Switch."
4242

4343
> [!NOTE]
4444
> Make sure to check "Allow management operating system to share this network adapter."
4545
46-
<img src="/docs/images/hyperv_linux_guest_vm/external-network.png" width="175" />
46+
<img src="/com.playeveryware.eos/Documentation~/images/hyperv_linux_guest_vm/external-network.png" width="175" />
4747

4848
When it's done it should look like this:
4949

@@ -55,33 +55,33 @@ The "Enhanced Session" feature of Hyper-V doesn't play very nicely with Ubuntu,
5555

5656
Go to Hyper-V Manager Actions bar and select "Hyper-V Settings..." and disable the "Use enhanced session mode."
5757

58-
<img src="/docs/images/hyperv_linux_guest_vm/enhanced-session.png" width="520" />
58+
<img src="/com.playeveryware.eos/Documentation~/images/hyperv_linux_guest_vm/enhanced-session.png" width="520" />
5959

6060
## Step 4: Creating a virtual machine to run Ubuntu 18.04
6161

6262
Ubuntu 18.04 is the official version of Linux that is supported by both EOS, the EOS Plugin, and the versions of unity the plugin supports. It might not be limited to this version, but it is certainly the most widely used, so it is best to perform testing on at least this platform.
6363

6464
1. Open Hyper-V Manager and select "Quick Create..." from the actions bar on the right-hand side.
6565

66-
<img src="/docs/images/hyperv_linux_guest_vm/quick-create.png" width="537" />
66+
<img src="/com.playeveryware.eos/Documentation~/images/hyperv_linux_guest_vm/quick-create.png" width="537" />
6767

6868
2. Select "Ubuntu 18.04 LTS" and make sure that the Network switch selected is set to the virtual switch you created earlier.
6969

70-
<img src="/docs/images/hyperv_linux_guest_vm/ubuntu-18.04%20LTS.png" width="600" />
70+
<img src="/com.playeveryware.eos/Documentation~/images/hyperv_linux_guest_vm/ubuntu-18.04-LTS.png" width="600" />
7171

7272
3. Click "Create Virtual Machine" and wait for the process to complete.
7373

7474
4. Click `Edit Settings`
7575

76-
<img src="/docs/images/hyperv_linux_guest_vm/edit-settings.png" width="450" />
76+
<img src="/com.playeveryware.eos/Documentation~/images/hyperv_linux_guest_vm/edit-settings.png" width="450" />
7777

7878
5. Select the hard drive in the left panel, and click `Edit`
7979

80-
<img src="/docs/images/hyperv_linux_guest_vm/vm-settings.png" width="450" />
80+
<img src="/com.playeveryware.eos/Documentation~/images/hyperv_linux_guest_vm/vm-settings.png" width="450" />
8181

8282
6. Expand the drive to _at least_ 40GB
8383

84-
<img src="/docs/images/hyperv_linux_guest_vm/expand.png" width="450" />
84+
<img src="/com.playeveryware.eos/Documentation~/images/hyperv_linux_guest_vm/expand.png" width="450" />
8585

8686
7. Once the Virtual Machine is created, connect to the virtual machine to complete the installation of Ubuntu.
8787
* When you get to the user creation portion of installation, make sure you do NOT enable "Log in automatically," as this will disable some of the capabilities that make using Hyper-V nice.

com.playeveryware.eos/Documentation~/dev_env/Ubuntu_Development_Environment.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<a href="/README.md"><img src="/docs/images/PlayEveryWareLogo.gif" alt="README.md" width="5%"/></a>
1+
<a href="/README.md"><img src="/com.playeveryware.eos/Documentation~/images/PlayEveryWareLogo.gif" alt="README.md" width="5%"/></a>
22

33
# <div align="center">Configuring Ubuntu 18.04 for development</div>
44
---

com.playeveryware.eos/Documentation~/docs_on_docs/doc_style_guide.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<a href="/README.md"><img src="/docs/images/PlayEveryWareLogo.gif" alt="README.md" width="5%"/></a>
1+
<a href="/README.md"><img src="/com.playeveryware.eos/Documentation~/images/PlayEveryWareLogo.gif" alt="README.md" width="5%"/></a>
22

33
# <div align="center">Documentation Style Guide</div>
44
---
@@ -40,13 +40,13 @@ Each document should start (before the document title) with the PlayEveryWare, I
4040
Markdown:
4141
```markdown
4242
<a href="/README.md">
43-
<img src="/docs/images/PlayEveryWareLogo.gif" alt="PlayEveryWare, Inc. Logo" width="10%"/>
43+
<img src="/com.playeveryware.eos/Documentation~/images/PlayEveryWareLogo.gif" alt="PlayEveryWare, Inc. Logo" width="10%"/>
4444
</a>
4545
```
4646

4747
What it looks like:
4848

49-
<a href="/README.md"><img src="/docs/images/PlayEveryWareLogo.gif" alt="PlayEveryWare, Inc. Logo" width="10%"/></a>
49+
<a href="/README.md"><img src="/com.playeveryware.eos/Documentation~/images/PlayEveryWareLogo.gif" alt="PlayEveryWare, Inc. Logo" width="10%"/></a>
5050

5151
## Title:
5252

@@ -138,7 +138,7 @@ What it looks like:
138138

139139
![unity tools package manager](/com.playeveryware.eos/Documentation~/images/unity_tools_package_manager.gif)
140140

141-
Always place images in the `/docs/images/` directory of the repository. In most cases, it is also appropriate to add a subdirectory to the images directory in order to keep related images organized. For instance, when creating a new document that contains a variety of images, it would be wise to create a subdirectory in the images folder to contain all the images for that new document.
141+
Always place images in the `/com.playeveryware.eos/Documentation~/images/` directory of the repository. In most cases, it is also appropriate to add a subdirectory to the images directory in order to keep related images organized. For instance, when creating a new document that contains a variety of images, it would be wise to create a subdirectory in the images folder to contain all the images for that new document.
142142

143143
> [!IMPORTANT]
144144
> Never use an image in place of text (for instance do not take a screenshot of documentation from one area to include it in another). Aside from the issue of maintainability, the problem with this is that GitHub allows for dark and light modes, and the image will look wrong in one mode or the other.

com.playeveryware.eos/Documentation~/frequently_asked_questions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,4 +152,4 @@ Or to install the libraries manually, go to the `lib/NativeCode` folder, find th
152152

153153
On the EOS Configuration Editor Window there is a setting for `Platform Flags`. By adding `DisableOverlay` to your list of Platform Flags, the Epic Overlay will not be initialized during runtime. When this is configured the `EOSBootstrapper.exe` will not be included in Windows builds.
154154

155-
See [`PlatformFlags.cs`](/Assets/Plugins/Source/EOS_SDK/Generated/Platform/PlatformFlags.cs)
155+
See [`PlatformFlags.cs`](/com.playeveryware.eos/Runtime/EOS_SDK/Generated/Platform/PlatformFlags.cs)

com.playeveryware.eos/Documentation~/iOS/README_iOS.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
<a href="/README.md"><img src="/docs/images/PlayEveryWareLogo.gif" alt="Lobby Screenshot" width="5%"/></a>
1+
<a href="/README.md"><img src="/com.playeveryware.eos/Documentation~/images/PlayEveryWareLogo.gif" alt="Lobby Screenshot" width="5%"/></a>
22

3-
<div align="center"> <img src="/docs/images/EOSPluginLogo.png" alt="PlayEveryWare EOS Plugin for Unity" /> </div>
3+
<div align="center"> <img src="/com.playeveryware.eos/Documentation~/images/EOSPluginLogo.png" alt="PlayEveryWare EOS Plugin for Unity" /> </div>
44

55

66
# <div align="center">iOS Getting Started</div>

0 commit comments

Comments
 (0)