Skip to content

Commit

Permalink
Corrected all instances of 'Github' to 'GitHub' (Reloaded-Project#52)
Browse files Browse the repository at this point in the history
* Corrected internal instances of 'Github' to 'GitHub'
	modified:   .github/ISSUE_TEMPLATE/help.md
	modified:   Docs/FAQ.md
	modified:   Docs/Include/Help.md
	modified:   Docs/UpdateSupport.md
	modified:   Source/Reloaded.Mod.Launcher/Assets/HTML/Help.html
	modified:   Source/Reloaded.Mod.Launcher/Assets/Images/Icon-Template.psd
	modified:   Source/Reloaded.Mod.Launcher/Assets/Languages/en-GB.xaml
	modified:   Source/Reloaded.Mod.Launcher/Assets/Languages/es-ES.xaml
	modified:   Source/Reloaded.Mod.Launcher/Errors.cs
	modified:   Source/Reloaded.Mod.Launcher/Pages/Dialogs/FirstLaunch.xaml
	modified:   Source/Reloaded.Mod.Launcher/Setup.cs
	modified:   Source/Reloaded.Mod.Launcher/Update.cs
	modified:   Source/Reloaded.Mod.Loader.Tests/HeroesControllerPostProcess.zip
	modified:   Source/Reloaded.Mod.Loader.Tests/HeroesControllerPostProcessBad.zip
	modified:   Source/Reloaded.Mod.Loader.Update/Dependency/LogBuilder.cs
	modified:   Source/Reloaded.Mod.Loader.Update/ResolverFactory.cs
	modified:   Source/Reloaded.Mod.Loader.Update/Resolvers/GithubLatestUpdateResolver.cs

* Removed files containing 'Github' to be re-uploaded
	deleted:    Source/Reloaded.Mod.Launcher/Assets/Images/Github-Icon.png
	deleted:    Source/Reloaded.Mod.Loader.Update/Resolvers/GithubLatestUpdateResolver.cs

* Re-uploaded files containing 'Github' with 'GitHub' instead
	new file:   Source/Reloaded.Mod.Launcher/Assets/Images/GitHub-Icon.png
	new file:   Source/Reloaded.Mod.Loader.Update/Resolvers/GitHubLatestUpdateResolver.cs

* Reverted problematic changes to hard-coded instances
	modified:   Source/Reloaded.Mod.Loader.Tests/HeroesControllerPostProcess.zip
	modified:   Source/Reloaded.Mod.Loader.Tests/HeroesControllerPostProcessBad.zip
	modified:   Source/Reloaded.Mod.Loader.Update/Resolvers/GitHubLatestUpdateResolver.cs

* Updated documentation to revert some changes
    comment:    010 Editor failed me and I thought this went through with the last commit
	modified:   Docs/UpdateSupport.md
.
  • Loading branch information
Sewer56 committed Sep 2, 2020
1 parent dbdb665 commit 5a392cb
Show file tree
Hide file tree
Showing 15 changed files with 63 additions and 63 deletions.
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/help.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ assignees: ''
You can see them right beside the download button on each official download.
You'll need all of them as stated.

**As seen on Github**:
**As seen on GitHub**:
![image](https://user-images.githubusercontent.com/6697380/90259427-e71e8900-de41-11ea-87aa-0ff27cf5e486.png)

**As seen on GameBanana**:
Expand All @@ -24,4 +24,4 @@ A clear and concise description of what you would like help with.
If applicable, add screenshots to help explain your problem.

**Additional Resources**
If the issue is related to any external resource e.g. specific version of a mod or pack, consider stating the version or linking the resource in question. Preferably though, mod specific issues should go in their own Github repositories as I in most cases would not be able to help.
If the issue is related to any external resource e.g. specific version of a mod or pack, consider stating the version or linking the resource in question. Preferably though, mod specific issues should go in their own GitHub repositories as I in most cases would not be able to help.
10 changes: 5 additions & 5 deletions Docs/FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,21 +8,21 @@ The most up to date version of this document can be found at: https://github.com
### What are the official download links for Reloaded?

The official downloads for Reloaded-II are on
- *Github* https://github.com/Reloaded-Project/Reloaded-II/releases
- *GitHub* https://github.com/Reloaded-Project/Reloaded-II/releases
- *GameBanana* https://gamebanana.com/tools/6693

Anything else is unofficial.

Github is always kept up to date while Gamebanana is sometimes updated slightly less periodically. Regardless of what you download, the launcher will always offer to update itself to the latest up to date version.
GitHub is always kept up to date while Gamebanana is sometimes updated slightly less periodically. Regardless of what you download, the launcher will always offer to update itself to the latest up to date version.

Complete documentation for Reloaded is available on Github: https://github.com/Reloaded-Project/Reloaded-II#reloaded-for-end-users.
Complete documentation for Reloaded is available on GitHub: https://github.com/Reloaded-Project/Reloaded-II#reloaded-for-end-users.

### Reloaded doesn't boot, what should I do?

Have you installed the dependencies?
No, seriously, 99% of the time it's just that.

Please look directly above the download button on both GameBanana and Github and download **ALL** of the linked dependencies.
Please look directly above the download button on both GameBanana and GitHub and download **ALL** of the linked dependencies.

### How do I get started with using Reloaded?

Expand Down Expand Up @@ -110,7 +110,7 @@ https://github.com/Reloaded-Project/Reloaded.Hooks

### How can I contribute to Reloaded?

The easiest way to contribute to Reloaded is to look at the issue list on Github: https://github.com/Reloaded-Project/Reloaded-II/issues
The easiest way to contribute to Reloaded is to look at the issue list on GitHub: https://github.com/Reloaded-Project/Reloaded-II/issues

Anything labelled as `accepted` is up for grabs by anyone, unless assigned to a specific user.
Just make sure to follow the coding style in the existing projects and try to write good code.
Expand Down
6 changes: 3 additions & 3 deletions Docs/Include/Help.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,14 @@ This is just a basic tiny document provided in case you get stuck 😊.
### What are the official download links for Reloaded?

The official downloads for Reloaded-II are on
- *Github* https://github.com/Reloaded-Project/Reloaded-II/releases
- *GitHub* https://github.com/Reloaded-Project/Reloaded-II/releases
- *GameBanana* https://gamebanana.com/tools/6693

Anything else is unofficial.

Github is always kept up to date while Gamebanana is sometimes updated slightly less periodically. Regardless of what you download, the launcher will always offer to update itself to the latest up to date version.
GitHub is always kept up to date while Gamebanana is sometimes updated slightly less periodically. Regardless of what you download, the launcher will always offer to update itself to the latest up to date version.

Complete documentation for Reloaded is available on Github: https://github.com/Reloaded-Project/Reloaded-II#reloaded-for-end-users.
Complete documentation for Reloaded is available on GitHub: https://github.com/Reloaded-Project/Reloaded-II#reloaded-for-end-users.

### Reloaded doesn't boot, what should I do?

Expand Down
20 changes: 10 additions & 10 deletions Docs/UpdateSupport.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
- [Supported Archive Formats](#supported-archive-formats)
- [Existing Services](#existing-services)
- [Reloaded II Repository](#reloaded-ii-repository)
- [Github](#github)
- [GitHub](#github)
- [Determining Version](#determining-version)
- [User Configuration](#user-configuration)
- [Limitations](#limitations)
Expand Down Expand Up @@ -66,11 +66,11 @@ Note for Serious Programmers:
There exists a standalone NuGet Package Converter released as part of Tools.zip alongside Reloaded releases (starting with 1.6.2). If you are using CI/CD for your mods, feel free to use this as part of your automatic deployment process.
```

### Github
### GitHub

**Support:** A package is considered as "supported" if the file below exists.

Support for mod updates from Github Releases can be added by copying the `ReloadedGithubUpdater.json` file from the Launcher's `Template` folder the to mod folder.
Support for mod updates from GitHub Releases can be added by copying the `ReloadedGithubUpdater.json` file from the Launcher's `Template` folder the to mod folder.

After copying, you should then edit the file to include the user/organization name, repository and name of the mod archive.

Expand All @@ -85,15 +85,15 @@ After copying, you should then edit the file to include the user/organization na
```

##### Determining Version
To determine the current version of the mod, the Github service uses the `ModVersion` field inside of your mod's `ModConfig.json`.
To determine the current version of the mod, the GitHub service uses the `ModVersion` field inside of your mod's `ModConfig.json`.

To determine the version on Github, the Github service uses the `tag` assigned to each release.
To determine the version on GitHub, the GitHub service uses the `tag` assigned to each release.

If the Github version is higher than the local one, there is an update.
If the GitHub version is higher than the local one, there is an update.

##### User Configuration

Each mod with Github update support can be configured by the user. This can be done by editing the `ReloadedGithubUserConfig.json` file, in the mod folder using a standard text editor.
Each mod with GitHub update support can be configured by the user. This can be done by editing the `ReloadedGithubUserConfig.json` file, in the mod folder using a standard text editor.

**Example file:**
```json
Expand All @@ -110,8 +110,8 @@ If not present, this file will appear the next time the Reloaded Launcher is lau
##### Limitations
- Prereleases are supported but semantic versioning is not. Please do not add any prefixes/suffixes to your release tags.

- Github only allows 60 requests an hour for unauthenticated users. This means that if you have many mods with Github update support, they might not receive updates immediately.
- The Github service tracks when each mod has been checked, ensuring that each mod gets the chance to check for updates, even if there are more than 60.
- GitHub only allows 60 requests an hour for unauthenticated users. This means that if you have many mods with GitHub update support, they might not receive updates immediately.
- The GitHub service tracks when each mod has been checked, ensuring that each mod gets the chance to check for updates, even if there are more than 60.

### GameBanana

Expand Down Expand Up @@ -180,7 +180,7 @@ Here is a simple rundown of how to add a new service for a 3rd party website.
### 1. Write a Resolver
Inside the `Resolvers` folder of the `Reloaded.Mod.Loader.Update` project, write a class that implements the `IModResolver` class.

**Example:** See `GithubLatestUpdateResolver`.
**Example:** See `GitHubLatestUpdateResolver`.

The class only needs to be able to determine if there's a newer version, Reloaded-II will always autoselect newest version to update regardless of how many updates are available.

Expand Down
6 changes: 3 additions & 3 deletions Source/Reloaded.Mod.Launcher/Assets/HTML/Help.html
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,12 @@ <h1 id="getting-started">Getting Started</h1>
<h3 id="what-are-the-official-download-links-for-reloaded">What are the official download links for Reloaded?</h3>
<p>The official downloads for Reloaded-II are on</p>
<ul>
<li><em>Github</em> <a href="https://github.com/Reloaded-Project/Reloaded-II/releases">https://github.com/Reloaded-Project/Reloaded-II/releases</a></li>
<li><em>GitHub</em> <a href="https://github.com/Reloaded-Project/Reloaded-II/releases">https://github.com/Reloaded-Project/Reloaded-II/releases</a></li>
<li><em>GameBanana</em> <a href="https://gamebanana.com/tools/6693">https://gamebanana.com/tools/6693</a></li>
</ul>
<p>Anything else is unofficial.</p>
<p>Github is always kept up to date while Gamebanana is sometimes updated slightly less periodically. Regardless of what you download, the launcher will always offer to update itself to the latest up to date version.</p>
<p>Complete documentation for Reloaded is available on Github: <a href="https://github.com/Reloaded-Project/Reloaded-II#reloaded-for-end-users">https://github.com/Reloaded-Project/Reloaded-II#reloaded-for-end-users</a>.</p>
<p>GitHub is always kept up to date while Gamebanana is sometimes updated slightly less periodically. Regardless of what you download, the launcher will always offer to update itself to the latest up to date version.</p>
<p>Complete documentation for Reloaded is available on GitHub: <a href="https://github.com/Reloaded-Project/Reloaded-II#reloaded-for-end-users">https://github.com/Reloaded-Project/Reloaded-II#reloaded-for-end-users</a>.</p>
<h3 id="reloaded-doesnt-boot-what-should-i-do">Reloaded doesn't boot, what should I do?</h3>
<p>Before running Reloaded you should download all of the requirements listed.</p>
<p><strong>Used by the mod loader:</strong></p>
Expand Down
Binary file modified Source/Reloaded.Mod.Launcher/Assets/Images/Icon-Template.psd
Binary file not shown.
10 changes: 5 additions & 5 deletions Source/Reloaded.Mod.Launcher/Assets/Languages/en-GB.xaml
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
<sys:String x:Key="AddAppAdvancedOptions">Advanced Tools &amp; Options</sys:String>
<sys:String x:Key="AddAppCreateShortcut">Create Shortcut</sys:String>
<sys:String x:Key="AddAppAutoInject">Auto-Inject</sys:String>
<sys:String x:Key="AddAppAutoInjectMessage" xml:space="preserve">Note: Auto-inject is provided but not recommended as no guarantee can be made that mods will execute code before the application.&#x0a;Please instead use regular "Launch Application" from Reloaded or the "DLL Loader" method described in the Github documentation.&#x0a;Please do not submit bugs for mods that do not work using Auto-inject mode.</sys:String>
<sys:String x:Key="AddAppAutoInjectMessage" xml:space="preserve">Note: Auto-inject is provided but not recommended as no guarantee can be made that mods will execute code before the application.&#x0a;Please instead use regular "Launch Application" from Reloaded or the "DLL Loader" method described in the GitHub documentation.&#x0a;Please do not submit bugs for mods that do not work using Auto-inject mode.</sys:String>

<sys:String x:Key="AddAppExecutableTitle">Select an application to create the configuration for.</sys:String>
<sys:String x:Key="AddAppExecutableFilter">Application Executable</sys:String>
Expand Down Expand Up @@ -162,7 +162,7 @@
<sys:String x:Key="UpdateLoaderNewVersion">New Version</sys:String>

<sys:String x:Key="UpdateLoaderChangelogUnavailable">No Changelog Available</sys:String>
<sys:String x:Key="UpdateLoaderChangelog">View Changelog on Github</sys:String>
<sys:String x:Key="UpdateLoaderChangelog">View Changelog on GitHub</sys:String>
<sys:String x:Key="UpdateLoaderUpdate">Update</sys:String>

<sys:String x:Key="UpdateLoaderRunningTitle">Applications Running</sys:String>
Expand Down Expand Up @@ -208,11 +208,11 @@
<sys:String x:Key="ErrorPathNullOrEmpty">The path to this application is either null or empty. Please fix the path.</sys:String>
<sys:String x:Key="ErrorFailedToGetDirectoryOfMod">Failed to get directory of mod to delete.</sys:String>
<sys:String x:Key="ErrorFailedToGetDirectoryOfApplication">Failed to get directory of application to delete.</sys:String>
<sys:String x:Key="ErrorLoaderNotFound">was not found. This may be caused by Antivirus software deleting and/or breaking changes in Github repository.</sys:String> <!-- Loader DLL Name displays before this message -->
<sys:String x:Key="ErrorLoaderNotFound">was not found. This may be caused by Antivirus software deleting and/or breaking changes in GitHub repository.</sys:String> <!-- Loader DLL Name displays before this message -->
<sys:String x:Key="ErrorFailedToStartProcess">Failed to start the process. Is your path correct?</sys:String>
<sys:String x:Key="ErrorDllInjectionFailed">Failed to DLL inject into application process.</sys:String>
<sys:String x:Key="ErrorPathToApplicationInvalid">The path to the application to be launched is invalid. Please re-check your application configuration.</sys:String>
<sys:String x:Key="ErrorCheckUpdatesFailed">Failed to check for updates. We are either being rate limited by Github or not connected to the internet.</sys:String>
<sys:String x:Key="ErrorCheckUpdatesFailed">Failed to check for updates. We are either being rate limited by GitHub or not connected to the internet.</sys:String>
<sys:String x:Key="ErrorGetProcAddress32Failed" xml:space="preserve">Warning: You are probably missing the x86 version of .NET Core, 32-bit applications will not work.&#x0a;Please re-check the requirements listed on the download page.&#x0a;Actual Error: Failed to acquire address of GetProcAddress for x86.</sys:String>

<!-- Asi Loader -->
Expand All @@ -236,7 +236,7 @@

<!-- Update 1.7.0: Loader Settings Icons -->
<sys:String x:Key="LoaderSettingsTwitter">Tweet Me</sys:String>
<sys:String x:Key="LoaderSettingsDonate">Sponsor Me on Github</sys:String>
<sys:String x:Key="LoaderSettingsDonate">Sponsor Me on GitHub</sys:String>
<sys:String x:Key="LoaderSettingsDiscord">Join the Discord Server</sys:String>

</ResourceDictionary>
4 changes: 2 additions & 2 deletions Source/Reloaded.Mod.Launcher/Assets/Languages/es-ES.xaml
Original file line number Diff line number Diff line change
Expand Up @@ -207,11 +207,11 @@
<sys:String x:Key="ErrorPathNullOrEmpty">La ruta para esta aplicación es nula o vacía. Corrija la ubicación.</sys:String>
<sys:String x:Key="ErrorFailedToGetDirectoryOfMod">Fallo al obtener la carpeta del mod a eliminar.</sys:String>
<sys:String x:Key="ErrorFailedToGetDirectoryOfApplication">Fallo al obtener la carpeta de la aplicación a eliminar.</sys:String>
<sys:String x:Key="ErrorLoaderNotFound">No fue encontrado. Esto puede haber sido causado por la eliminación del software desde un antivirus y/o por la ruptura de cambios en el repositorio de Github.</sys:String> <!-- Loader DLL Name displays before this message -->
<sys:String x:Key="ErrorLoaderNotFound">No fue encontrado. Esto puede haber sido causado por la eliminación del software desde un antivirus y/o por la ruptura de cambios en el repositorio de GitHub.</sys:String> <!-- Loader DLL Name displays before this message -->
<sys:String x:Key="ErrorFailedToStartProcess">No se pudo iniciar el proceso. ¿Tu ruta es correcta?</sys:String>
<sys:String x:Key="ErrorDllInjectionFailed">Falló al inyectar el DLL en el proceso de registro.</sys:String>
<sys:String x:Key="ErrorPathToApplicationInvalid">La ruta a iniciar para la aplicación no es válida. Compruebe de nuevo la configuración de su aplicación.</sys:String>

<sys:String x:Key="ErrorCheckUpdatesFailed">No se pudieron verificar las actualizaciones. Estamos limitados por Github o no conectados a Internet.</sys:String>
<sys:String x:Key="ErrorCheckUpdatesFailed">No se pudieron verificar las actualizaciones. Estamos limitados por GitHub o no conectados a Internet.</sys:String>

</ResourceDictionary>
2 changes: 1 addition & 1 deletion Source/Reloaded.Mod.Launcher/Errors.cs
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ public static class Errors
public static string PathNullOrEmpty() => ApplicationResourceAcquirer.GetTypeOrAlternative("ErrorPathNullOrEmpty", "The path to this application is either null or empty. Please fix the path.");
public static string FailedToGetDirectoryOfMod() => ApplicationResourceAcquirer.GetTypeOrAlternative("ErrorFailedToGetDirectoryOfMod", "Failed to get directory of mod to delete.");
public static string FailedToGetDirectoryOfApplication() => ApplicationResourceAcquirer.GetTypeOrAlternative("ErrorFailedToGetDirectoryOfApplication", "Failed to get directory of application to delete.");
public static string LoaderNotFound() => ApplicationResourceAcquirer.GetTypeOrAlternative("ErrorLoaderNotFound", "was not found. This may be caused by Antivirus software deleting and/or breaking changes in Github repository.");
public static string LoaderNotFound() => ApplicationResourceAcquirer.GetTypeOrAlternative("ErrorLoaderNotFound", "was not found. This may be caused by Antivirus software deleting and/or breaking changes in GitHub repository.");
public static string FailedToStartProcess() => ApplicationResourceAcquirer.GetTypeOrAlternative("ErrorFailedToStartProcess", "Failed to start the process. Is your path correct?");
public static string DllInjectionFailed() => ApplicationResourceAcquirer.GetTypeOrAlternative("ErrorDllInjectionFailed", "Failed to DLL inject into application process.");
public static string PathToApplicationInvalid() => ApplicationResourceAcquirer.GetTypeOrAlternative("ErrorPathToApplicationInvalid", "The path to the application to be launched is invalid. Please re-check your application configuration.");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@

<StackPanel Grid.Column="0" Orientation="Horizontal" PreviewMouseDown="Documents_PreviewMouseDown">
<Image Height="48"
Source="pack://application:,,,/Reloaded-II;Component/Assets/Images/Github-Icon.png"
Source="pack://application:,,,/Reloaded-II;Component/Assets/Images/GitHub-Icon.png"
Style="{DynamicResource HighQualityImage}"
Margin="{DynamicResource ListEntryItemMarginSmall}"/>
<TextBlock Text="{DynamicResource FirstLaunchLineDocumentation}"
Expand Down
4 changes: 2 additions & 2 deletions Source/Reloaded.Mod.Launcher/Setup.cs
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,7 @@ private static async Task SetupViewModelsAsync()
LoaderConfigReader.WriteConfiguration(config);
Errors.HandleException(ex, "Failed to parse Reloaded-II launcher configuration.\n" +
"This is a rare bug, your settings have been reset.\n" +
"If you have encountered this please report this to the Github issue tracker.\n" +
"If you have encountered this please report this to the GitHub issue tracker.\n" +
"Any information on how to reproduce this would be very, very welcome.\n");
}

Expand Down Expand Up @@ -270,7 +270,7 @@ private static void CreateTemplates()
if (!Directory.Exists(templatesDirectory))
Directory.CreateDirectory(templatesDirectory);

GithubLatestUpdateResolver.GithubConfig.ToPath(new GithubLatestUpdateResolver.GithubConfig(), $"{GithubLatestUpdateResolver.GithubConfig.GetFilePath(templatesDirectory)}");
GitHubLatestUpdateResolver.GitHubConfig.ToPath(new GitHubLatestUpdateResolver.GitHubConfig(), $"{GitHubLatestUpdateResolver.GitHubConfig.GetFilePath(templatesDirectory)}");
GameBananaUpdateResolver.GameBananaConfig.ToPath(new GameBananaUpdateResolver.GameBananaConfig(), $"{GameBananaUpdateResolver.GameBananaConfig.GetFilePath(templatesDirectory)}");
}

Expand Down
Loading

0 comments on commit 5a392cb

Please sign in to comment.