Skip to content

Commit 90e009d

Browse files
JoshPiperJoshPiper
authored
Merge branch 'development' into development
2 parents f5f402f + b9da14a commit 90e009d

File tree

212 files changed

+4373
-917
lines changed

Some content is hidden

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

212 files changed

+4373
-917
lines changed

‎.github/CONTRIBUTING.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Contributor Guidelines
2+
3+
These guidelines have been written to ensure that code, issues and pull requests are to a good standard;
4+
allowing for easier maintence and implementation.
5+
6+
## Code
7+
8+
### Style
9+
10+
Code should follow the style outlined in [Limelight Standards Document #1](https://limelightgaming.net/docs/LSD-1.pdf).
11+
12+
### License
13+
14+
Contributors agree to their code being published under the Creative Commons Non-Commercial Attribution license and the Steam Workshop T&C.
15+
16+
## Pull Requests
17+
18+
- Pull requests should be titled meaningfully.
19+
- PRs should focus on one main feature or change each.
20+
- PRs should target development branch, not master.
21+
22+
## Issues
23+
24+
- Issues should have meaningful titles.
25+
- Each issue should focus on one feature or issue.
26+
- Issues should be appropriately labelled (feature / enhancement / bug / library)

‎.github/GOVERNANCE.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Photon Lighting Governance
2+
3+
As a community grows, it's important to know who's doing what, and who's responsible for making decisions.
4+
5+
## Core Development Team
6+
7+
The CDT are those who have been recognised, either for their promotion of Photon (library components, vehicles, etc) or contributing developments to Photon itself.
8+
These users have commit access to the various repositories and may have other elevated permissions if required.
9+
These users have final responsibility for decisions made about Photon.
10+
11+
### Support Lead
12+
13+
The support lead has authority over the support team, is responsible for ensuring ongoing support and the management of support staff.
14+
15+
## Development
16+
17+
These users may are recognised for their skills, again for the promotion or development of Photon, and may have commit access to repos.

‎.github/SUPPORT.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Support Resources
2+
3+
Support for Photon can be found in various places.
4+
5+
## Wiki
6+
7+
General development guides, component lists and user guides can be found in the [Photon Wiki](https://github.com/photonle/Photon/wiki).
8+
9+
## Development Discord
10+
11+
Direct support, discussion, Q&A and more resources can be found in our [Discord Guild](https://discord.gg/5KaUVYj).
12+
13+
## Bugs
14+
15+
Bugs should be reported on the [Issue Tracker](https://github.com/photonle/Photon/issues).

‎.github/label-pr.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
- regExp: "library\/sirens\/"
2+
labels: ["libary"]
3+
- regExp: "library\/auto\/"
4+
labels: ["libary"]
5+
- regExp: "library\/default\/"
6+
labels: ["libary"]
7+
- regExp: "library\/vehicles\/"
8+
labels: ["libary"]

‎.github/workflows/documentation.yml‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
name: Documentation
2+
on:
3+
push:
4+
paths-ignore:
5+
- 'docs/**'
6+
- '.github/**'
7+
tags:
8+
- '*'
9+
branches:
10+
- development
11+
- dev
12+
13+
jobs:
14+
build:
15+
runs-on: ubuntu-latest
16+
steps:
17+
-
18+
name: Checkout
19+
uses: actions/checkout@v1
20+
-
21+
name: Install Lua
22+
uses: leafo/gh-actions-lua@v3
23+
-
24+
name: Install Luarocks
25+
uses: leafo/gh-actions-luarocks@v2
26+
-
27+
name: Install Dependencies
28+
run: |
29+
luarocks install luafilesystem
30+
luarocks install penlight
31+
luarocks install markdown
32+
luarocks install argparse
33+
luarocks install ldoc
34+
-
35+
name: Build
36+
run: ldoc -M -c ./config.ld -t 'Photon Lighting Documentation' -d ./docs ./lua
37+
-
38+
name: Upload
39+
uses: actions/upload-artifact@v1.0.0
40+
with:
41+
name: docs
42+
path: ./docs
43+
-
44+
name: Commit
45+
uses: EndBug/add-and-commit@v2.1.0
46+
with:
47+
author_name: Documentation Generator
48+
author_email: docs@photon.lighting
49+
message: "Updated Documentation"
50+
path: "./docs"
51+
env:
52+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

‎.github/workflows/labeller.yml‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
name: PR Labeller
2+
on: [pull_request]
3+
4+
jobs:
5+
label:
6+
runs-on: ubuntu-18.04
7+
steps:
8+
# We need to checkout the repository to access the configured file (.github/label-pr.yml)
9+
- uses: actions/checkout@v1
10+
with:
11+
fetch-depth: 1
12+
- name: Labeler
13+
uses: docker://decathlon/pull-request-labeler-action:2.0.0
14+
env:
15+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

‎.github/workflows/library.yml‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: Library Checks
2+
on:
3+
push:
4+
paths-ignore:
5+
- 'docs/**'
6+
7+
jobs:
8+
sirens:
9+
runs-on: ubuntu-latest
10+
steps:
11+
-
12+
name: Checkout
13+
uses: actions/checkout@v1
14+
-
15+
name: Install Lua
16+
uses: leafo/gh-actions-lua@v3
17+
with:
18+
luaVersion: "5.1.5"
19+
-
20+
name: Install Dependencies
21+
uses: Legion2/download-release-action@v2.1.0
22+
with:
23+
repository: photonle/linter-library
24+
tag: 'v1.0.0'
25+
-
26+
name: Lint
27+
run: |
28+
cd linter-library-1.0.0
29+
lua sirenlint.lua ../lua/autorun/photon/library/sirens/*

‎README.md‎

Lines changed: 35 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,40 @@ This is the official GitHub page for the Photon Lighting Engine. Code is license
55

66
## Contributing
77
Pull requests are welcome, but code may be adjusted before publish. Anyone who contributes will be appropriately credited on the addon page.
8+
Before you contribute, be sure to read the [Contribution Guidelines](.github/CONTRIBUTING.md).
89

910
## Branching Model
10-
Releases are tagged on master branch.
11-
Master contains code which is either live, or being packed for live.
12-
Development contains code which should be ready for live, but hasn't been validated or merged.
13-
feature/ and fix/ braches contain code under development.
11+
Code under development is worked on in separate feature branches / forks. When this code is ready for testing, it's merged into development.
12+
13+
Code on the development branch is tested by the team to ensure it works as intended, and is then merged into the master branch.
14+
15+
The master branch contains code which is ready to go live. When the code goes live, the release is tagged on master.
16+
17+
## Credits
18+
19+
### [Core Development Team](.github/GOVERNANCE.md#core-development-team)
20+
21+
The Core Development team currently contains 7 people.
22+
23+
| Name | Role |
24+
| --- | --- |
25+
| [ischmal](https://github.com/ischmal) | Photon Engine code, photon.lighting website |
26+
| [Noble](https://github.com/Noble-N9) | Photon Fire and Rescue, various components |
27+
| [TheSenDest](https://github.com/TheSenDest) | Photon vehicles & components. |
28+
| GermanDude | Photon vehicles |
29+
| [Super Mighty](https://github.com/SuperMighty1) | Photon vehicles & components. |
30+
| [creator_2013](https://github.com/creator2013) | Photon Engine code & Components & Vehicles |
31+
| [Joshua Piper](https://github.com/JoshPiper) | Photon Engine code, Discord Bot, external services & security.
32+
33+
### [Development Team](.github/GOVERNANCE.md#development)
34+
35+
| Name | Role |
36+
| --- | --- |
37+
| SGM | Vehicle Creator |
38+
| Deputy.Jones | Vehicle Creator |
39+
| goigle | Photon Core code |
40+
| TDM | Vehicle Creator|
41+
42+
### Other
43+
44+
Christmas Cracker icon provided by Made, AU, from thenounproject.com.

‎config.ld‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
tparam_alias("ply", "Player")
2+
tparam_alias("vec", "Vector")
3+
tparam_alias("ent", "Entity")
4+
tparam_alias("color", "Color")
5+
tparam_alias("veh", "Vehicle")
6+
tparam_alias("ang", "Angle")

‎docs/index.html‎

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<html>
44
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
55
<head>
6-
<title>Reference</title>
6+
<title>Photon Lighting Documentation</title>
77
<link rel="stylesheet" href="ldoc.css" type="text/css" />
88
</head>
99
<body>
@@ -31,8 +31,9 @@ <h1>ldoc</h1>
3131

3232
<h2>Modules</h2>
3333
<ul class="nowrap">
34-
<li><a href="modules/lua.autorun.emv_init.html">lua.autorun.emv_init</a></li>
34+
<li><a href="modules/autorun.emv_init.html">autorun.emv_init</a></li>
3535
<li><a href="modules/Photon.AirEL.html">Photon.AirEL</a></li>
36+
<li><a href="modules/EMVU.html">EMVU</a></li>
3637
</ul>
3738

3839
</div>
@@ -44,20 +45,24 @@ <h2>Modules</h2>
4445
<h2>Modules</h2>
4546
<table class="module_list">
4647
<tr>
47-
<td class="name" nowrap><a href="modules/lua.autorun.emv_init.html">lua.autorun.emv_init</a></td>
48+
<td class="name" nowrap><a href="modules/autorun.emv_init.html">autorun.emv_init</a></td>
4849
<td class="summary">Photon Init</td>
4950
</tr>
5051
<tr>
5152
<td class="name" nowrap><a href="modules/Photon.AirEL.html">Photon.AirEL</a></td>
5253
<td class="summary">AirEl Client Handler.</td>
5354
</tr>
55+
<tr>
56+
<td class="name" nowrap><a href="modules/EMVU.html">EMVU</a></td>
57+
<td class="summary">Photon EMV Client Loader.</td>
58+
</tr>
5459
</table>
5560

5661
</div> <!-- id="content" -->
5762
</div> <!-- id="main" -->
5863
<div id="about">
5964
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
60-
<i style="float:right;">Last updated 2019-02-17 22:57:19 </i>
65+
<i style="float:right;">Last updated 2019-10-29 21:25:34 </i>
6166
</div> <!-- id="about" -->
6267
</div> <!-- id="container" -->
6368
</body>

0 commit comments

Comments
 (0)