Skip to content

Commit 10305bb

Browse files
scowaltscowalt
authored
CI + ReadME + StyleCop + FxCop (#8)
* CI, Readme, StyleCop Can I build with dotnet? Another try, with nuget to hopefully pull .net dependency Copy+paste fail Readme overhaul Some potential progress Working style enforcement, starting to work through errors Partially working styling, but can't customize rules ruleset is linked appropriately, starting to chip away at rules Fixing more style warnings More rule refinement More attempted settings work More desperately trying to fix things More refactor work done Using namespaces inside namespace scope More formatting work More styling work More styling changes More styling progress More styling progress Fix Auto generate errors CI on push and PR Minor readme fix Trailing newlines Minor README update for build badge Another readme change Fixed up bad merges Patched up remaining issues * Fixed remaining styling errors * Starting FxCopAnalyzers integration * Adding more rules to exception list * More rules * More rule work * More FxCop work * More rule work * Final rule changes
1 parent 813c64c commit 10305bb

169 files changed

Lines changed: 1738 additions & 1774 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/workflows/build.yml‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
name: Build
2+
on: [push, pull_request]
3+
4+
jobs:
5+
build:
6+
runs-on: windows-2019
7+
steps:
8+
- uses: actions/checkout@v1
9+
- name: Setup Nuget.exe
10+
uses: warrenbuckley/Setup-Nuget@v1
11+
- name: Restore packages
12+
run: nuget restore RTCV.sln
13+
- name: Setup MSBuild.exe
14+
uses: warrenbuckley/Setup-MSBuild@v1
15+
- name: Build with MSBuild
16+
run: msbuild RTCV.sln

‎.gitignore‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,5 @@ packages
77
x64
88
x86
99
build
10-
Output/*
10+
Output/*
11+
StyleCop.Cache

‎Directory.Build.props‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
<Project>
2+
<PropertyGroup>
3+
<CodeAnalysisRuleSet>$(SolutionDir)StyleCop.ruleset</CodeAnalysisRuleSet>
4+
</PropertyGroup>
5+
<ItemGroup>
6+
<PackageReference Include="StyleCop.Analyzers" Version="1.1.1-rc.108" PrivateAssets="all" />
7+
<PackageReference Include="Microsoft.CodeAnalysis.FxCopAnalyzers" Version="3.0.0" PrivateAssets="all" />
8+
</ItemGroup>
9+
</Project>

‎LICENSE‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2018 Phil Girard & Daniel Barreiro
3+
Copyright (c) 2018-2020 Phil Girard & Daniel Barreiro
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

‎README.md‎

Lines changed: 32 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,31 @@
1+
<p align="center">
2+
<a href="https://corrupt.wiki/"><img src="Assets/Graphical Assets/Vanguard/icon.ico" alt="RTCV Icon" /></a>
3+
</p>
4+
5+
<p align="center">
6+
<!-- Github action -->
7+
<a href="https://github.com/ircluzar/RTCV/actions?query=workflow%3ABuild+branch%3Amaster"><img src="https://github.com/ircluzar/RTCV/workflows/Build/badge.svg?branch=master" alt="Build status badge" /></a>
8+
<!-- Wiki -->
9+
<a href="https://corrupt.wiki/"><img src="https://img.shields.io/badge/docs-corrupt.wiki-blue.svg" alt="Docs wiki badge" /></a>
10+
<!-- Download -->
11+
<a href="https://redscientist.com/rtc"><img src="https://img.shields.io/badge/download-RTC-red.svg" alt="Download badge" /></a>
12+
<!-- Discord -->
13+
<a href="https://corrupt.wiki/corruptors/rtc/expert#rtc-dev-discord"><img src="https://img.shields.io/discord/279664862836031488.svg" alt="Chat badge" /></a>
14+
<!-- Trello -->
15+
<a href="https://trello.com/b/9QYo50OC/rtcv"><img src="https://img.shields.io/badge/planning-Trello-blue.svg" alt="Trello badge" /></a>
16+
</p>
17+
118
# RTCV - Real-Time Corruptor Vanguard
2-
Real-Time Corruptor, Vanguard, CorruptCore, NetCore2, RTC Launcher
19+
20+
> Real-Time Corruptor, Vanguard, CorruptCore, NetCore2, RTC Launcher
321
422
Real-Time Corruptor Vanaguard is a Dynamic Corruptor for games. It is a set of libraries that can be rigged up to any program that can load the CLR and works by corrupting data in memory to force glitches. RTCV currently comes with implementations for [Bizhawk](https://github.com/ircluzar/Bizhawk-Vanguard), [Dolphin](https://github.com/NarryG/dolphin-vanguard/), [PCSX2](https://github.com/NarryG/pcsx2-Vanguard), [melonDS](https://github.com/narryg/melonds-vanguard), and [Windows Processes](https://github.com/narryg/processstub-vanguard).
523

6-
Features:
7-
- Corrupts in real-time
8-
- Supports various emulators via a generic API. Currently comes with Bizhawk, Dolphin, PCSX2, melonDS, and Windows real-time implementations.
24+
Icon graciously provided by [ShyGuyXXL](https://twitter.com/shyguyxxl)
25+
26+
## Features
27+
- Corrupts in real-time
28+
- Supports various emulators via a generic API. Currently comes with Bizhawk, Dolphin, PCSX2, melonDS, and Windows real-time implementations.
929
- Supports corrupting files on-disk via the FileStub implementation, as well as including specialized support for certain kinds of files (WiiU games via CemuStub & Unity games via UnityStub).
1030
- Many corruption engines with customizable algorithms
1131
- Easy start option for autocorrupt
@@ -22,11 +42,13 @@ Features:
2242
- The Vector Engine is a specialty corruption engine designed for 3D systems. The included lists target systems that support IEEE754 Floating Point values
2343
- The Custom Engine allows you to create your own engine using the various corruption parameters.
2444

45+
## Development
46+
### Recommended: Visual Studio 2019
47+
[Visual Studio 2019: Community Edition](https://visualstudio.microsoft.com/vs/community/) is a free IDE for open-source projects, and is recommended for RTCV.
2548

26-
Please consult the Official Wiki for software documentation. https://corrupt.wiki
27-
28-
Download link: http://redscientist.com/rtc
29-
Trello: https://trello.com/b/9QYo50OC/rtcv
49+
### Without Visual Studio
3050

31-
32-
Icon graciously provided by [ShyGuyXXL](https://twitter.com/shyguyxxl)
51+
1. Install [chocolatey](https://chocolatey.org/install)
52+
1. `cinst -y visualstudio2019buildtools nuget.commandline`
53+
1. `nuget restore RTCV.sln`
54+
1. `msbuild.exe`

‎Source/Frontend/StandaloneRTC/Loading.Designer.cs‎

Lines changed: 30 additions & 30 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎Source/Frontend/StandaloneRTC/Loading.cs‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
using System;
2-
using System.IO;
3-
using System.Linq;
4-
using System.Reflection;
5-
using System.Windows.Forms;
6-
using RTCV.UI;
7-
8-
namespace StandaloneRTC
1+
namespace StandaloneRTC
92
{
3+
using System;
4+
using System.IO;
5+
using System.Linq;
6+
using System.Reflection;
7+
using System.Windows.Forms;
8+
using RTCV.UI;
9+
1010
public partial class Loader : UI_Extensions.RTC_Standalone_Form
1111
{
1212
public Loader(string[] args)

‎Source/Frontend/StandaloneRTC/Program.cs‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
using System;
2-
using System.IO;
3-
using System.Reflection;
4-
using System.Threading;
5-
using System.Windows.Forms;
6-
7-
namespace StandaloneRTC
1+
namespace StandaloneRTC
82
{
3+
using System;
4+
using System.IO;
5+
using System.Reflection;
6+
using System.Threading;
7+
using System.Windows.Forms;
8+
99
static class Program
1010
{
1111
static Form loaderObject;
@@ -50,7 +50,7 @@ private static void StartLoader(string[] args)
5050
}
5151

5252
/// <summary>
53-
/// Global exceptions in Non User Interfarce(other thread) antipicated error
53+
/// Global exceptions in Non User Interface(other thread) anticipated error
5454
/// </summary>
5555
/// <param name="sender"></param>
5656
/// <param name="e"></param>
@@ -62,7 +62,7 @@ private static void CurrentDomainOnUnhandledException(object sender, UnhandledEx
6262
}
6363

6464
/// <summary>
65-
/// Global exceptions in User Interfarce antipicated error
65+
/// Global exceptions in User Interface anticipated error
6666
/// </summary>
6767
/// <param name="sender"></param>
6868
/// <param name="e"></param>

‎Source/Frontend/StandaloneRTC/Properties/AssemblyInfo.cs‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
using System.Reflection;
22
using System.Runtime.InteropServices;
33

4-
// General Information about an assembly is controlled through the following
4+
// General Information about an assembly is controlled through the following
55
// set of attributes. Change these attribute values to modify the information
66
// associated with an assembly.
77
[assembly: AssemblyTitle("StandaloneRTC")]
@@ -13,8 +13,8 @@
1313
[assembly: AssemblyTrademark("")]
1414
[assembly: AssemblyCulture("")]
1515

16-
// Setting ComVisible to false makes the types in this assembly not visible
17-
// to COM components. If you need to access a type in this assembly from
16+
// Setting ComVisible to false makes the types in this assembly not visible
17+
// to COM components. If you need to access a type in this assembly from
1818
// COM, set the ComVisible attribute to true on that type.
1919
[assembly: ComVisible(false)]
2020

@@ -24,11 +24,11 @@
2424
// Version information for an assembly consists of the following four values:
2525
//
2626
// Major Version
27-
// Minor Version
27+
// Minor Version
2828
// Build Number
2929
// Revision
3030
//
31-
// You can specify all the values or you can default the Build and Revision Numbers
31+
// You can specify all the values or you can default the Build and Revision Numbers
3232
// by using the '*' as shown below:
3333
// [assembly: AssemblyVersion("1.0.*")]
3434
[assembly: AssemblyVersion("1.0.0.0")]

‎Source/Frontend/StandaloneRTC/StandaloneRTC.csproj‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@
1212
<TargetFrameworkVersion>v4.7.1</TargetFrameworkVersion>
1313
<FileAlignment>512</FileAlignment>
1414
<TargetFrameworkProfile />
15+
<CodeAnalysisRuleSet>..\..\..\StyleCop.ruleset</CodeAnalysisRuleSet>
16+
<AutoGenerateBindingRedirects>true</AutoGenerateBindingRedirects>
1517
</PropertyGroup>
1618
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
1719
<PlatformTarget>AnyCPU</PlatformTarget>
@@ -56,7 +58,6 @@
5658
<PlatformTarget>x64</PlatformTarget>
5759
<UseVSHostingProcess>false</UseVSHostingProcess>
5860
<ErrorReport>prompt</ErrorReport>
59-
<CodeAnalysisRuleSet>MinimumRecommendedRules.ruleset</CodeAnalysisRuleSet>
6061
</PropertyGroup>
6162
<PropertyGroup Condition="'$(Configuration)|$(Platform)' == 'Release|x64'">
6263
<OutputPath>..\..\..\Build\</OutputPath>
@@ -67,7 +68,6 @@
6768
<PlatformTarget>x64</PlatformTarget>
6869
<UseVSHostingProcess>false</UseVSHostingProcess>
6970
<ErrorReport>prompt</ErrorReport>
70-
<CodeAnalysisRuleSet>MinimumRecommendedRules.ruleset</CodeAnalysisRuleSet>
7171
</PropertyGroup>
7272
<PropertyGroup Condition="'$(Configuration)|$(Platform)' == 'Debug|x86'">
7373
<PlatformTarget>x86</PlatformTarget>
@@ -144,7 +144,7 @@
144144
<PropertyGroup>
145145
<PostBuildEvent>rd /s /q "cs", "pl", "pt-BR", "tr", "de", "en", "es", "fr", "it", "ja", "ko", "ru", "zh-Hans", "zh-Hant"</PostBuildEvent>
146146
</PropertyGroup>
147-
<!-- To modify your build process, add your task inside one of the targets below and uncomment it.
147+
<!-- To modify your build process, add your task inside one of the targets below and uncomment it.
148148
Other similar extension points exist, see Microsoft.Common.targets.
149149
<Target Name="BeforeBuild">
150150
</Target>

0 commit comments

Comments
 (0)