Skip to content

Commit 9365efa

Browse files
skuzzisskuzzis
committed
feat(project): README, Workflows and LICENSE
1 parent 83c961d commit 9365efa

File tree

5 files changed

+179
-0
lines changed

5 files changed

+179
-0
lines changed

‎.github/FUNDING.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
custom: https://www.tipeeestream.com/skuzzi/donation

‎.github/workflows/builder.yml‎

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
name: "Swiftly Compiler"
2+
3+
on:
4+
push:
5+
branches:
6+
- '**'
7+
pull_request:
8+
9+
jobs:
10+
build:
11+
name: Build
12+
runs-on: ${{ matrix.os }}
13+
env:
14+
MMSOURCE20: ${{ github.workspace }}/swiftly/alliedmodders/metamod
15+
HL2SDKCS2: ${{ github.workspace }}/swiftly/alliedmodders/hl2sdk
16+
container: ${{ matrix.container }}
17+
strategy:
18+
fail-fast: false
19+
matrix:
20+
os: [Linux, windows-latest]
21+
include:
22+
- os: Linux
23+
container: registry.gitlab.steamos.cloud/steamrt/sniper/sdk
24+
steps:
25+
- name: Checkout
26+
uses: actions/checkout@v4
27+
with:
28+
path: swiftly
29+
submodules: recursive
30+
31+
- name: Checkout AMBuild
32+
uses: actions/checkout@v4
33+
with:
34+
repository: alliedmodders/ambuild
35+
path: ambuild
36+
37+
- name: Install AMBuild
38+
run: |
39+
cd ambuild; python setup.py install; cd ..
40+
41+
- name: Build - Linux
42+
if: matrix.os == 'Linux'
43+
working-directory: swiftly
44+
shell: bash
45+
run: |
46+
sudo apt update
47+
sudo apt install -y libreadline-dev libboost-all-dev fdupes unzip
48+
bash ./setup.sh
49+
50+
- name: Prepare Build - Windows
51+
if: matrix.os == 'windows-latest'
52+
working-directory: swiftly
53+
run: |
54+
./setup.ps1
55+
56+
- name: Upload Artifacts Linux
57+
if: matrix.os == 'Linux'
58+
uses: actions/upload-artifact@v4
59+
with:
60+
name: Swiftly Plugin Linux
61+
path: ${{ github.workspace }}/swiftly/build/package
62+
63+
- name: Upload Artifacts Windows
64+
if: matrix.os == 'windows-latest'
65+
uses: actions/upload-artifact@v4
66+
with:
67+
name: Swiftly Plugin Windows
68+
path: ${{ github.workspace }}/swiftly/build/package

‎.github/workflows/cleanup.yml‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
name: Clean Artifacts
2+
3+
on:
4+
schedule:
5+
- cron: "0 0 * * *"
6+
workflow_dispatch:
7+
8+
jobs:
9+
clean:
10+
permissions:
11+
actions: write
12+
runs-on: self-hosted
13+
steps:
14+
- name: Cleanup
15+
uses: c-hive/gha-remove-artifacts@v1
16+
with:
17+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
18+
age: "1 minute"
19+
skip-recent: 20

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2023 Sava Andrei Sebastian
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
<br/>
2+
<p align="center">
3+
<img src="https://sttci.b-cdn.net/status.swiftlycs2.net/2105/logo.png" alt="Swiftly Private Message Logo" width="600" height="131">
4+
<p align="center">
5+
Swiftly is a server modification plugin for Counter Strike 2 servers which is based on Metamod:Source 2.x
6+
<br/>
7+
<a href="https://github.com/swiftly-solution/swiftly/issues">Report Bug</a>
8+
<a href="https://swiftlycs2.net/discord">Discord Server</a>
9+
</p>
10+
</p>
11+
12+
<div align="center">
13+
14+
![Downloads](https://img.shields.io/github/downloads/swiftly-solution/swiftly/total) ![Contributors](https://img.shields.io/github/contributors/swiftly-solution/swiftly?color=dark-green) ![Issues](https://img.shields.io/github/issues/swiftly-solution/swiftly) ![License](https://img.shields.io/github/license/swiftly-solution/swiftly)
15+
16+
</div>
17+
18+
---
19+
### Build Requirements
20+
- [hl2sdk](https://github.com/alliedmodders/hl2sdk/tree/cs2) (Downloads automatically with the git cloning using Recurse Submodules)
21+
- [metamod-source](https://github.com/alliedmodders/metamod-source) (Downloads automatically with the git cloning using Recurse Submodules)
22+
- [python3](https://www.python.org/)
23+
- [AMBuild](https://github.com/alliedmodders/ambuild) (MAKE SURE `ambuild` COMMAND IS AVAILABLE VIA `PATH` FOR WINDOWS)
24+
---
25+
### Downloads
26+
- [Public Releases (recomended)](https://github.com/swiftly-solution/swiftly/releases)
27+
- [Builds (use at your own risk)](https://github.com/swiftly-solution/swiftly/actions)
28+
---
29+
### Get Plugins
30+
- [Discord (recomended)](https://swiftlycs2.net/discord)
31+
- [GitHub Topic](https://github.com/topics/swiftly-solution)
32+
---
33+
### For Developers
34+
- [My First Lua Plugin](https://swiftlycs2.net/docs/my-first-plugin/lua.html)
35+
- [Documentation](https://swiftlycs2.net)
36+
---
37+
### Building Commands
38+
39+
#### Close Repository
40+
41+
```
42+
git clone --recurse-submodules https://github.com/swiftly-solution/swiftly
43+
```
44+
45+
#### Build
46+
47+
```
48+
./setup.ps1 - Windows
49+
./setup.sh - Linux
50+
```
51+
52+
---
53+
54+
### License
55+
56+
Swiftly is licensed under the MIT License. You can view the license in the LICENSE file.
57+
58+
---
59+
60+
### Credits
61+
62+
The Schema System and the base SDK classes fields provided by [CS2Fixes](https://github.com/Source2ZE/CS2Fixes).
63+
The rest of SDK fields were provided by [Source2SDK](https://github.com/neverlosecc/source2sdk/tree/cs2/sdk).
64+
Thanks to GAMMACASE, Poggu, and all the people which are constantly working for the Counter Strike 2 Server Community to become better.
65+
66+
---
67+
68+
### Statistics
69+
70+
![Alt](https://repobeats.axiom.co/api/embed/742f846684c4bb9f8314c0a43c2a6b314fc63b6b.svg "Repobeats analytics image")

0 commit comments

Comments
 (0)