Skip to content

Commit

Permalink
Preparations for going v1
Browse files Browse the repository at this point in the history
  • Loading branch information
Pogromca-SCP committed Oct 17, 2024
1 parent fc25889 commit 42d6587
Show file tree
Hide file tree
Showing 14 changed files with 30 additions and 20 deletions.
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ Steps to reproduce the behavior:
**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.
**Attachments**
If applicable, add screenshots, logs and other attachments to help explain your problem.

**Desktop (please complete the following information):**
- OS [e.g. Windows 10]
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@ A clear and concise description of what you want to happen.
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
Add any other context and attachments about the feature request here.
2 changes: 1 addition & 1 deletion .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Build SLCommand Script
name: Build SLCommandScript

on:
push:
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ jobs:
publish:
runs-on: windows-latest
steps:
- name: Download Package
- name: Download package
id: download
uses: robinraju/release-downloader@v1
with:
Expand All @@ -20,8 +20,8 @@ jobs:
with:
dotnet-version: 8.0.x

- name: Publish Package
- name: Publish package
shell: pwsh
run: |
dotnet nuget push ${{ fromJson(steps.download.outputs.downloaded_files)[0] }} --api-key ${{ secrets.GITHUB_TOKEN }} --source https://nuget.pkg.github.com/Pogromca-SCP/index.json --skip-duplicate
#dotnet nuget push ${{ fromJson(steps.download.outputs.downloaded_files)[0] }} --api-key ${{ secrets.NUGET_TOKEN }} --source https://api.nuget.org/v3/index.json --skip-duplicate
dotnet nuget push ${{ fromJson(steps.download.outputs.downloaded_files)[0] }} --api-key ${{ secrets.NUGET_TOKEN }} --source https://api.nuget.org/v3/index.json --skip-duplicate
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

## [1.0.0] - 2024-10-17

### Added

- Initial plugin version made with [NwPluginAPI v13.1.2](https://github.com/northwood-studios/NwPluginAPI/releases/tag/13.1.2).
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# SLCommandScript
[![GitHub release](https://flat.badgen.net/github/release/Pogromca-SCP/SLCommandScript)](https://github.com/Pogromca-SCP/SLCommandScript/releases)
[![NuGet core release](https://flat.badgen.net/nuget/v/SLCommandScript.Core/latest)](https://www.nuget.org/packages/SLCommandScript.Core)
[![GitHub license](https://flat.badgen.net/github/license/Pogromca-SCP/SLCommandScript)](https://github.com/Pogromca-SCP/SLCommandScript/blob/main/LICENSE)
![GitHub downloads](https://flat.badgen.net/github/assets-dl/Pogromca-SCP/SLCommandScript)
![GitHub last commit](https://flat.badgen.net/github/last-commit/Pogromca-SCP/SLCommandScript/main)
Expand All @@ -22,6 +23,9 @@ This project was developed as part of the educational process at [PJAIT](https:/
3. Unzip the contents of the downloaded `*.zip` file into your server's plugin dependencies folder `{ServerDirectory}/PluginAPI/plugins/{port|global}/dependencies`.
4. Restart the server.

## Documentation
Documentation for users and developers can be found in [project wiki](https://github.com/Pogromca-SCP/SLCommandScript/wiki).

## Configuration
### Plugin Config
| Name | Type | Default value | Description |
Expand Down
3 changes: 2 additions & 1 deletion SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
## Supported Versions
| Version | Supported |
| ------- | ------------------ |
| < 1.0.0 | :white_check_mark: |
| 1.x.x | :white_check_mark: |
| < 1.0.0 | :x: |

## Reporting a Vulnerability
Please report all vulnerabilities in the issues section with label `vulnerability`.
2 changes: 1 addition & 1 deletion SLCommandScript.Core/Constants.cs
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ public static class Constants
/// <summary>
/// Contains current project version.
/// </summary>
public const string ProjectVersion = "0.13.0";
public const string ProjectVersion = "1.0.0";

/// <summary>
/// Contains project author.
Expand Down
2 changes: 1 addition & 1 deletion SLCommandScript.Core/Properties/AssemblyInfo.cs
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
using System.Reflection;

[assembly: AssemblyTitle(Constants.ProjectName)]
[assembly: AssemblyDescription("Contains core components for SLCS language.")]
[assembly: AssemblyDescription("Provides core components, interfaces and utilities for SLCS language.")]
[assembly: AssemblyProduct("SLCommandScript")]
[assembly: AssemblyCopyright("Copyright © 2023-present " + Constants.ProjectAuthor)]
[assembly: AssemblyVersion(Constants.ProjectVersion)]
Expand Down
6 changes: 3 additions & 3 deletions SLCommandScript.Core/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# SLCommandScript.Core
Contains core components for SLCS language.
Provides core components, interfaces and utilities for Secret Lab Command Script language.

Manually adding references to SCP:SL assemblies in your project might be necessarry when using certain classes.
Manually adding references to SCP: Secret Laboratory assemblies in your project might be necessary when using certain classes.

Full documentation for developers can be found in [project repository](https://github.com/Pogromca-SCP/SLCommandScript).
Full documentation for developers can be found in [project wiki](https://github.com/Pogromca-SCP/SLCommandScript/wiki).
## Basic usage examples for common use cases
### Creating custom permissions resolver
```csharp
Expand Down
8 changes: 4 additions & 4 deletions SLCommandScript.Core/SLCommandScript.Core.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<PackageId>SLCommandScript.Core</PackageId>
<Authors>Adam Szerszenowicz</Authors>
<Product>SLCommandScript</Product>
<Description>Contains core components for SLCS language.</Description>
<Description>Provides core components, interfaces and utilities for Secret Lab Command Script language.</Description>
<PackageProjectUrl>https://github.com/Pogromca-SCP/SLCommandScript</PackageProjectUrl>
<PackageIcon>logo.jpg</PackageIcon>
<PackageReadmeFile>README.md</PackageReadmeFile>
Expand All @@ -25,13 +25,13 @@
<NeutralLanguage>en</NeutralLanguage>
<PackageLicenseFile>LICENSE</PackageLicenseFile>
<PackageRequireLicenseAcceptance>True</PackageRequireLicenseAcceptance>
<GeneratePackageOnBuild>true</GeneratePackageOnBuild>
<GeneratePackageOnBuild>false</GeneratePackageOnBuild>
<GenerateDocumentationFile>True</GenerateDocumentationFile>
<EnablePackageValidation>true</EnablePackageValidation>
<Title>SLCommandScript.Core</Title>
<Copyright>Copyright © 2023-present Adam Szerszenowicz</Copyright>
<PackageVersion>0.13.0-rc</PackageVersion>
<PackageValidationBaselineVersion>0.12.0</PackageValidationBaselineVersion>
<PackageVersion>1.0.0</PackageVersion>
<PackageValidationBaselineVersion>1.0.0</PackageValidationBaselineVersion>
</PropertyGroup>
<ItemGroup>
<None Include="README.md" Pack="True" PackagePath="/" />
Expand Down
2 changes: 1 addition & 1 deletion SLCommandScript.FileScriptsLoader/FileScriptsLoader.cs
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ public class FileScriptsLoader : IScriptsLoader
/// <summary>
/// Contains current project version.
/// </summary>
public const string ProjectVersion = "0.7.0";
public const string ProjectVersion = "1.0.0";

/// <summary>
/// Contains project author.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
using System.Reflection;

[assembly: AssemblyTitle(FileScriptsLoader.ProjectName)]
[assembly: AssemblyDescription("Filesystem Scripts Loader for SL Command Script.")]
[assembly: AssemblyDescription("Filesystem Scripts Loader implementation for SLCommandScript.")]
[assembly: AssemblyProduct("SLCommandScript")]
[assembly: AssemblyCopyright("Copyright © 2023-present " + FileScriptsLoader.ProjectAuthor)]
[assembly: AssemblyVersion(FileScriptsLoader.ProjectVersion)]
Expand Down
2 changes: 1 addition & 1 deletion SLCommandScript/Plugin.cs
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ public class Plugin
/// <summary>
/// Contains current plugin version.
/// </summary>
public const string PluginVersion = "0.8.0";
public const string PluginVersion = "1.0.0";

/// <summary>
/// Contains plugin description.
Expand Down

0 comments on commit 42d6587

Please sign in to comment.