Skip to content

Commit

Permalink
Prepare for initial release
Browse files Browse the repository at this point in the history
Add the various things that need to be added for an initial release.
  • Loading branch information
rurounijones committed May 30, 2022
1 parent 58eb9ef commit ec441c2
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 5 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ guide.
Make sure to give the bot `Slash Command` permissions when inviting it into your
Discord.

Once the bot has been invited make sure to restrict permissions regarding who
is allowed to run the commands and in what channels. This can be done from
**Once the bot has been invited make sure to restrict permissions regarding who
is allowed to run the commands and in what channels**. This can be done from
within the administration menu for your Discord server in the `Integrations`
tab.

Expand All @@ -31,7 +31,7 @@ tab.
1. Download Custodian from URL and extract into a folder of your choice.
2. Modify the `configuration.yaml` file to suit your installation. The file
has comments that explain the various options.
3. Run the bot using the `Service.exe` or optionally run as a Windows Service
3. Run the bot using the `Custodian.exe` or optionally run as a Windows Service
(See below). For the initial runs we recommend not running as a service
to make sure everything is setup correctly.

Expand All @@ -41,5 +41,5 @@ Run the following command in a Powershell window with administrator
permissions, making sure to change the path to point to the correct location.

```
New-Service -Name Custodian -BinaryPathName C:\YOUR\PATH\TO\CUSTODIAN\Service.exe -Description "Discord Bot for DCS Administration" -DisplayName "Custodian" -StartupType Automatic
New-Service -Name Custodian -BinaryPathName C:\YOUR\PATH\TO\Custodian.exe -Description "Discord Bot for DCS Administration" -DisplayName "Custodian" -StartupType Automatic
```
18 changes: 17 additions & 1 deletion Service/Service.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,27 @@
<Nullable>enable</Nullable>
<ImplicitUsings>enable</ImplicitUsings>
<UserSecretsId>dotnet-Service-591B29EE-15D7-4562-B8A8-0B4DF728802B</UserSecretsId>
<AssemblyName>$(MSBuildProjectName)</AssemblyName>
<AssemblyName>Custodian</AssemblyName>
<RootNamespace>RurouniJones.Custodian.$(MSBuildProjectName.Replace(" ", "_"))</RootNamespace>
<PackageId>$(AssemblyName)</PackageId>
<Company>$(Authors)</Company>
<Product>Custodian</Product>
<Description>A Discord bot that allows DCS server administration via slash commands</Description>
<Authors>Jeffrey Jones</Authors>
<Copyright>Copyright Jeffrey Jones 2022</Copyright>
<PackageProjectUrl>https://github.com/DCS-gRPC/Custodian</PackageProjectUrl>
<PackageReadmeFile>README.md</PackageReadmeFile>
<RepositoryUrl>https://github.com/DCS-gRPC/Custodian</RepositoryUrl>
<RepositoryType>git</RepositoryType>
</PropertyGroup>

<ItemGroup>
<None Include="..\README.md">
<Pack>True</Pack>
<PackagePath>\</PackagePath>
</None>
</ItemGroup>

<ItemGroup>
<PackageReference Include="NetEscapades.Configuration.Yaml" Version="2.1.0" />
<PackageReference Include="Microsoft.Extensions.Hosting" Version="6.0.0" />
Expand Down

0 comments on commit ec441c2

Please sign in to comment.