fix ci && rename contrib.md (#10)

.github/workflows/Awesome-Game-Analysis.yml

@@ -5,13 +5,39 @@ name: Awesome-Game-Analysis
 
 on:
   push:
+    branches:
+      - main
     paths:
       - 'data/games.toml'
+  pull_request:
+    branches:
+      - main
 
 jobs:
-  build:
+  pr_job:
     runs-on: ubuntu-latest
+    if: github.event_name == 'pull_request'
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
 
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.11.4
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r scripts/requirements.txt
+
+      - name: Execute Python scripts
+        id: execute-scripts
+        run: python scripts/toml_markdown.py -i data/games.toml -t toml --readme
+  push_job:
+    runs-on: ubuntu-latest
+    if: github.event_name == 'push'
+    needs: pr_job
     steps:
       - name: Checkout repository
         uses: actions/checkout@v2
@@ -27,16 +53,24 @@ jobs:
           pip install -r scripts/requirements.txt
 
       - name: Execute Python scripts
+        id: execute-scripts
         run: python scripts/toml_markdown.py -i data/games.toml -t toml --readme
 
+      - name: Get commit message
+        id: get-commit-message
+        run: |
+          echo "Setting commit message."
+          COMMIT_MSG="Update from data/games.toml"
+          echo "::set-output name=commit-message::$COMMIT_MSG"
+
       - name: Commit changes
         run: |
           if [ "${{ steps.execute-scripts.outcome }}" == "success" ]; then
             commit_message="${{ steps.get-commit-message.outputs.commit-message }}"
             git config --global user.name "K1ngst0m"
             git config --global user.email "kingstom.chen@gmail.com"
             git add .
-            git commit -m "$commit_message"
+            git commit --allow-empty -m "$commit_message"
             git push
           else
             echo "Execution failed. Exiting."

CONTRIBUTING.md

@@ -0,0 +1,55 @@
+# Contribution Guide
+
+This guide outlines the steps to contribute to our game information repository. We appreciate your interest and effort to help improve our database.
+
+
+## Step 0: Gather Game Information
+
+Before you begin contributing, make sure you've collected all the required game information. This includes:
+
+- The title of the game
+- The game's developer(studio)
+- The engine used to develop the game
+- The year the game was released
+- Any links relevant to the game's analysis
+
+Such information can be obtained from reliable sources like official game websites, developer interviews, or public resources like Wikipedia.
+
+## Step 1: Add the Game Information
+
+After you've collected all the necessary data, add it to the data/games.toml file following the provided format. Please append this information to the end of the file.
+
+The required format is as follows:
+
+```toml
+["Game Name"]
+Developer = "Developer"
+Engine = "Engine Used"
+Year = "Year of Release"
+Analysis = [
+  ["Title of Link 1", "https://link1.com"],
+  ["Title of Link 2", "https://link2.com"],
+  ....
+]
+```
+
+Replace the placeholders with the appropriate game information. For the Analysis section, list all the analysis links you've obtained in the same way.
+
+## Step 2 (optional): Test README.md File Generation
+
+Once you've added the game information to the `data/games.toml` file, it's good practice to check if the `README.md` file generation works correctly.
+
+Run the following command in the `scripts/toml_markdown.py` script:
+
+``` bash
+$ python scripts/toml_markdown.py -i data/games.toml -t toml --readme
+```
+
+This command converts the `data/games.toml` file into a `README.md` file. Note that the file conversion is automatically executed by our Continuous Integration (CI) system.
+
+
+## Step 3: Create a Pull Request
+
+Finally, create a pull request with the changes you made to the `data/games.toml` file. Please provide a brief yet comprehensive description of the changes you've made (e.g., new game entries, typo corrections) in the pull request.
+
+We appreciate your contribution and efforts to enhance our game information repository. Thank you for making our community stronger and more informed!

data/games.toml

@@ -207,8 +207,6 @@ Analysis = [
   ["Balázs Török's Blog", "http://morad.in/2019/03/27/observations-about-the-rendering-of-metro-exodus/"],
 ]
 
-
-
 ["Cyberpunk 2077"]
 Developer = "CD Projekt Red"
 Engine = "REDengine 4"
@@ -217,10 +215,10 @@ Analysis = [
   ["c0de517e", "https://c0de517e.blogspot.com/2020/12/hallucinations-re-rendering-of.html"],
   ["Hang Zhang's Blog", "https://zhangdoa.com/rendering-analysis-cyberpunk-2077"],
   ["Shader Execution Reordering", "https://chipsandcheese.com/2023/05/16/shader-execution-reordering-nvidia-tackles-divergence/"],
+  ["Tech Focus: Cyberpunk 2077 RT Overdrive", "https://www.youtube.com/watch?v=vigxRma2EPA"],
+  ["Overdrive Technology Preview on RTX 4090", "https://www.youtube.com/watch?v=I-ORt8313Og"],
 ]
 
-
-
 ["Zelda - Wind Waker"]
 Developer = "Nintendo EAD"
 Engine = "Internal"
@@ -251,6 +249,7 @@ Year = "2019"
 Analysis = [
   ["Frame Analysis", "https://alain.xyz/blog/frame-analysis-control"],
   ["Destructible Environments in Control: Lessons in Procedural Destruction", "https://www.youtube.com/watch?v=kODJsQGXanU"],
+  ["Control PC's Stealth Upgrade", "https://www.youtube.com/watch?v=HyLA3lhRdwM"],
 ]
 
 
@@ -1882,3 +1881,36 @@ Year = "2010"
 Analysis = [
 ["ALAN WAKE: The Writer Who Made Us Rewrite Our Engine", "https://www.youtube.com/watch?v=73KjaHcsdlo"],
 ]
+
+["Final Fantasy 13"]
+Developer = "Square Enix"
+Engine = "Crystal Tools"
+Year = "2009"
+Analysis = [
+["Tech Evolution: Final Fantasy 13 CGI vs Final Fantasy 16 Real-Time Graphics", "https://www.youtube.com/watch?v=ItwtpX1SFcA"],
+]
+
+["Final Fantasy 16"]
+Developer = "Square Enix"
+Engine = "Internal"
+Year = "2023"
+Analysis = [
+["Tech Evolution: Final Fantasy 13 CGI vs Final Fantasy 16 Real-Time Graphics", "https://www.youtube.com/watch?v=ItwtpX1SFcA"],
+["The DF Tech Review", "https://www.youtube.com/watch?v=_Oyjldkh5kE"],
+]
+
+["F1 2023"]
+Developer = "Codemasters"
+Engine = "EGO"
+Year = "2023"
+Analysis = [
+["PS5 vs Xbox Series X/S vs PC – Ray Tracing", "https://www.youtube.com/watch?v=DVakUY6lqj8"],
+]
+
+["Company of Heroes 3"]
+Developer = "Relic Entertainment"
+Engine = "Essence Engine 4.0"
+Year = "2023"
+Analysis = [
+["Company of Heroes 3 - From PC to Consoles", "https://www.youtube.com/watch?v=Q7_PSmWxOv8"],
+]