📝 Update documentation

alicerunsonfedora · Sep 26, 2021 · a19ecf7 · a19ecf7
1 parent dbf7a33
commit a19ecf7
Show file tree

Hide file tree

Showing 353 changed files with 2,482 additions and 1,981 deletions.
diff --git a/.jazzy.yml b/.jazzy.yml
@@ -5,7 +5,7 @@ github_url: "https://github.com/alicerunsonfedora/CS400"
 theme: jony
 
 min_acl: internal
-build_tool_arguments: ["-workspace", "Conscious.xcodeproj/project.xcworkspace", "-scheme" ,"Conscious"]
+build_tool_arguments: ["-workspace", "Conscious.xcodeproj/project.xcworkspace", "-scheme" ,"Game", "-destination", "arch=arm64"]
 documentation: "./Guides/*.md"
 
 exclude: "./Conscious/Classes/App/*,./Conscious/Views/*,./Conscious/Assets/TealConverse.mlmodel/*"

diff --git a/Conscious/Classes/App/AppDelegate.swift b/Conscious/Classes/App/AppDelegate.swift
@@ -69,7 +69,7 @@ class AppDelegate: NSObject, NSApplicationDelegate {
             dockTile.display()
         }
     }
-    
+
     static func showReloadedPrompt() {
         guard let sceneController = NSApplication.shared.mainWindow?.contentViewController else { return }
         let viewController = NSViewController()
@@ -169,7 +169,7 @@ class AppDelegate: NSObject, NSApplicationDelegate {
     @IBAction func restorePurchases(_ sender: Any) {
         IAPObserver.shared.restore()
     }
-    
+
     @IBAction func showReloadedPromptFromMenu(_ sender: Any) {
         AppDelegate.showReloadedPrompt()
     }

diff --git a/Conscious/Classes/Scenes/Interfaces/MainMenu.swift b/Conscious/Classes/Scenes/Interfaces/MainMenu.swift
@@ -45,7 +45,7 @@ class MainMenuScene: SKScene, GKGameCenterControllerDelegate {
 
     /// The sprite node for the Watch Your Step DLC.
     var watchYourStepButton: SKSpriteNode?
-    
+
     /// The sprite node for the 'Try The Costumemaster: Reloaded' button.
     var reloadedButton: SKSpriteNode?
 
@@ -117,7 +117,7 @@ class MainMenuScene: SKScene, GKGameCenterControllerDelegate {
             self.watchYourStepButton = dlcButton
             self.watchYourStepButton?.texture?.filteringMode = .nearest
         }
-        
+
         if let reloadedButton = self.childNode(withName: "reloadedButton") as? SKSpriteNode {
             self.reloadedButton = reloadedButton
         }
@@ -150,7 +150,7 @@ class MainMenuScene: SKScene, GKGameCenterControllerDelegate {
             sceneViewController.dismiss(gameCenterViewController)
         }
     }
-    
+
     /// Insantiates the Game Center access point introduced in macOS 11.
     ///
     /// This is used to show the player their Game Center achievements and leaderboard scores.

diff --git a/Conscious/Utilities/Extensions/Scenes/MainMenu_Extension.swift b/Conscious/Utilities/Extensions/Scenes/MainMenu_Extension.swift
@@ -160,7 +160,7 @@ extension MainMenuScene {
             sceneViewController.presentAsSheet(gameCenterController)
         }
     }
-    
+
     private func reloadedAction() {
         AppDelegate.showReloadedPrompt()
     }

diff --git a/Conscious/Views/ReloadedView.swift b/Conscious/Views/ReloadedView.swift
@@ -8,9 +8,9 @@
 import SwiftUI
 
 struct ReloadedView: View {
-    
+
     var onDismiss: () -> Void
-    
+
     var body: some View {
         VStack {
             HStack(alignment: .top, spacing: 16) {
@@ -22,7 +22,9 @@ struct ReloadedView: View {
                     Text("It's time to reload.")
                         .font(.system(.title, design: .monospaced))
                         .bold()
-                    Text("The Costumemaster: Reloaded brings you the Costumemaster experience you love and more, with support for controllers, a brand new design with better graphics, localizations for Spanish and French, and other improvements.")
+                    Text("The Costumemaster: Reloaded brings you the Costumemaster experience you love and more, "
+                         + "with support for controllers, a brand new design with better graphics, localizations for "
+                         + "Spanish and French, and other improvements.")
                 }
                 .padding(.top, 8)
             }
@@ -49,7 +51,7 @@ struct ReloadedView: View {
         .preferredColorScheme(.dark)
         .frame(width: 600)
     }
-    
+
     func openStoreUrl() {
         NSWorkspace.shared.open(
             URL(string: "https://apps.apple.com/us/app/the-costumemaster-reloaded/id1573181569")!
@@ -59,7 +61,7 @@ struct ReloadedView: View {
 
 struct ReloadedView_Previews: PreviewProvider {
     static var previews: some View {
-        ReloadedView() {
+        ReloadedView {
             print("Hi")
         }
     }

diff --git a/Gemfile.lock b/Gemfile.lock
@@ -1,103 +1,111 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    CFPropertyList (3.0.2)
-    activesupport (4.2.11.3)
-      i18n (~> 0.7)
-      minitest (~> 5.1)
-      thread_safe (~> 0.3, >= 0.3.4)
-      tzinfo (~> 1.1)
-    algoliasearch (1.27.4)
+    CFPropertyList (3.0.4)
+      rexml
+    activesupport (6.1.4.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    algoliasearch (1.27.5)
       httpclient (~> 2.8, >= 2.8.3)
       json (>= 1.5.1)
     atomos (0.1.3)
     claide (1.0.3)
-    cocoapods (1.9.3)
-      activesupport (>= 4.0.2, < 5)
+    cocoapods (1.11.2)
+      addressable (~> 2.8)
       claide (>= 1.0.2, < 2.0)
-      cocoapods-core (= 1.9.3)
+      cocoapods-core (= 1.11.2)
       cocoapods-deintegrate (>= 1.0.3, < 2.0)
-      cocoapods-downloader (>= 1.2.2, < 2.0)
+      cocoapods-downloader (>= 1.4.0, < 2.0)
       cocoapods-plugins (>= 1.0.0, < 2.0)
       cocoapods-search (>= 1.0.0, < 2.0)
-      cocoapods-stats (>= 1.0.0, < 2.0)
       cocoapods-trunk (>= 1.4.0, < 2.0)
       cocoapods-try (>= 1.1.0, < 2.0)
       colored2 (~> 3.1)
       escape (~> 0.0.4)
       fourflusher (>= 2.3.0, < 3.0)
       gh_inspector (~> 1.0)
-      molinillo (~> 0.6.6)
+      molinillo (~> 0.8.0)
       nap (~> 1.0)
-      ruby-macho (~> 1.4)
-      xcodeproj (>= 1.14.0, < 2.0)
-    cocoapods-core (1.9.3)
-      activesupport (>= 4.0.2, < 6)
+      ruby-macho (>= 1.0, < 3.0)
+      xcodeproj (>= 1.21.0, < 2.0)
+    cocoapods-core (1.11.2)
+      activesupport (>= 5.0, < 7)
+      addressable (~> 2.8)
       algoliasearch (~> 1.0)
       concurrent-ruby (~> 1.1)
       fuzzy_match (~> 2.0.4)
       nap (~> 1.0)
       netrc (~> 0.11)
+      public_suffix (~> 4.0)
       typhoeus (~> 1.0)
-    cocoapods-deintegrate (1.0.4)
-    cocoapods-downloader (1.4.0)
+    cocoapods-deintegrate (1.0.5)
+    cocoapods-downloader (1.5.1)
     cocoapods-plugins (1.0.0)
       nap
-    cocoapods-search (1.0.0)
-    cocoapods-stats (1.1.0)
-    cocoapods-trunk (1.5.0)
+    cocoapods-search (1.0.1)
+    cocoapods-trunk (1.6.0)
       nap (>= 0.8, < 2.0)
       netrc (~> 0.11)
     cocoapods-try (1.2.0)
     colored2 (3.1.2)
-    concurrent-ruby (1.1.7)
+    concurrent-ruby (1.1.9)
     escape (0.0.4)
-    ethon (0.12.0)
-      ffi (>= 1.3.0)
-    ffi (1.13.1)
+    ethon (0.14.0)
+      ffi (>= 1.15.0)
+    ffi (1.15.4)
     fourflusher (2.3.1)
     fuzzy_match (2.0.4)
     gh_inspector (1.1.3)
     httpclient (2.8.3)
-    i18n (0.9.5)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    jazzy (0.13.5)
+    jazzy (0.14.0)
       cocoapods (~> 1.5)
       mustache (~> 1.1)
-      open4
+      open4 (~> 1.3)
       redcarpet (~> 3.4)
+      rexml (~> 3.2)
       rouge (>= 2.0.6, < 4.0)
       sassc (~> 2.1)
       sqlite3 (~> 1.3)
       xcinvoke (~> 0.3.0)
-    json (2.3.1)
+    json (2.5.1)
     liferaft (0.0.6)
-    minitest (5.14.2)
-    molinillo (0.6.6)
+    minitest (5.14.4)
+    molinillo (0.8.0)
     mustache (1.1.1)
     nanaimo (0.3.0)
     nap (1.1.0)
     netrc (0.11.0)
     open4 (1.3.4)
+    public_suffix (4.0.6)
     redcarpet (3.5.1)
-    rouge (3.23.0)
-    ruby-macho (1.4.0)
+    rexml (3.2.5)
+    rouge (3.26.1)
+    ruby-macho (2.5.1)
     sassc (2.4.0)
       ffi (~> 1.9)
     sqlite3 (1.4.2)
-    thread_safe (0.3.6)
     typhoeus (1.4.0)
       ethon (>= 0.9.0)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
     xcinvoke (0.3.0)
       liferaft (~> 0.0.6)
-    xcodeproj (1.18.0)
+    xcodeproj (1.21.0)
       CFPropertyList (>= 2.3.3, < 4.0)
       atomos (~> 0.1.3)
       claide (>= 1.0.2, < 2.0)
       colored2 (~> 3.1)
       nanaimo (~> 0.3.0)
+      rexml (~> 3.2.4)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby

diff --git a/docs/AI - Components.html b/docs/AI - Components.html
@@ -19,7 +19,7 @@
       <div class="content-wrapper">
         <p>
           <a href="index.html">The Costumemaster</a>
-          <span class="no-mobile"> (100% documented)</span>
+          <span class="no-mobile"> (98% documented)</span>
         </p>
 
         <p class="header-right">
@@ -668,10 +668,10 @@ <h4>Declaration</h4>
                   <a href="Structs/AIStateRecordable.html">AIStateRecordable</a>
                 </li>
                 <li class="nav-group-task">
-                  <a href="Structs/GameLevelItem.html">GameLevelItem</a>
+                  <a href="Structs/AchievementEntry.html">AchievementEntry</a>
                 </li>
                 <li class="nav-group-task">
-                  <a href="Structs/GamePreferences.html">GamePreferences</a>
+                  <a href="Structs/GameLevelItem.html">GameLevelItem</a>
                 </li>
               </ul>
             </li>
@@ -680,8 +680,8 @@ <h4>Declaration</h4>
       </div>
       <div class="footer-wrapper">
         <section id="footer">
-          <p>&copy; 2020 <a class="link" href="https://marquiskurt.net" target="_blank" rel="external">Marquis Kurt</a>. All rights reserved. (Last updated: 2020-11-18)</p>
-          <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
+          <p>&copy; 2021 <a class="link" href="https://marquiskurt.net" target="_blank" rel="noopener" rel="external">Marquis Kurt</a>. All rights reserved. (Last updated: 2021-09-26)</p>
+          <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="noopener" rel="external">jazzy ♪♫ v0.14.0</a>, a <a class="link" href="https://realm.io" target="_blank" rel="noopener" rel="external">Realm</a> project.</p>
         </section>
       </div>
     </div>

diff --git a/docs/AI - Decision Tree Strategies.html b/docs/AI - Decision Tree Strategies.html
@@ -19,7 +19,7 @@
       <div class="content-wrapper">
         <p>
           <a href="index.html">The Costumemaster</a>
-          <span class="no-mobile"> (100% documented)</span>
+          <span class="no-mobile"> (98% documented)</span>
         </p>
 
         <p class="header-right">
@@ -492,10 +492,10 @@ <h4>Declaration</h4>
                   <a href="Structs/AIStateRecordable.html">AIStateRecordable</a>
                 </li>
                 <li class="nav-group-task">
-                  <a href="Structs/GameLevelItem.html">GameLevelItem</a>
+                  <a href="Structs/AchievementEntry.html">AchievementEntry</a>
                 </li>
                 <li class="nav-group-task">
-                  <a href="Structs/GamePreferences.html">GamePreferences</a>
+                  <a href="Structs/GameLevelItem.html">GameLevelItem</a>
                 </li>
               </ul>
             </li>
@@ -504,8 +504,8 @@ <h4>Declaration</h4>
       </div>
       <div class="footer-wrapper">
         <section id="footer">
-          <p>&copy; 2020 <a class="link" href="https://marquiskurt.net" target="_blank" rel="external">Marquis Kurt</a>. All rights reserved. (Last updated: 2020-11-18)</p>
-          <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
+          <p>&copy; 2021 <a class="link" href="https://marquiskurt.net" target="_blank" rel="noopener" rel="external">Marquis Kurt</a>. All rights reserved. (Last updated: 2021-09-26)</p>
+          <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="noopener" rel="external">jazzy ♪♫ v0.14.0</a>, a <a class="link" href="https://realm.io" target="_blank" rel="noopener" rel="external">Realm</a> project.</p>
         </section>
       </div>
     </div>

diff --git a/docs/AI - Random Move Strategies.html b/docs/AI - Random Move Strategies.html
@@ -19,7 +19,7 @@
       <div class="content-wrapper">
         <p>
           <a href="index.html">The Costumemaster</a>
-          <span class="no-mobile"> (100% documented)</span>
+          <span class="no-mobile"> (98% documented)</span>
         </p>
 
         <p class="header-right">
@@ -520,10 +520,10 @@ <h4>Declaration</h4>
                   <a href="Structs/AIStateRecordable.html">AIStateRecordable</a>
                 </li>
                 <li class="nav-group-task">
-                  <a href="Structs/GameLevelItem.html">GameLevelItem</a>
+                  <a href="Structs/AchievementEntry.html">AchievementEntry</a>
                 </li>
                 <li class="nav-group-task">
-                  <a href="Structs/GamePreferences.html">GamePreferences</a>
+                  <a href="Structs/GameLevelItem.html">GameLevelItem</a>
                 </li>
               </ul>
             </li>
@@ -532,8 +532,8 @@ <h4>Declaration</h4>
       </div>
       <div class="footer-wrapper">
         <section id="footer">
-          <p>&copy; 2020 <a class="link" href="https://marquiskurt.net" target="_blank" rel="external">Marquis Kurt</a>. All rights reserved. (Last updated: 2020-11-18)</p>
-          <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
+          <p>&copy; 2021 <a class="link" href="https://marquiskurt.net" target="_blank" rel="noopener" rel="external">Marquis Kurt</a>. All rights reserved. (Last updated: 2021-09-26)</p>
+          <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="noopener" rel="external">jazzy ♪♫ v0.14.0</a>, a <a class="link" href="https://realm.io" target="_blank" rel="noopener" rel="external">Realm</a> project.</p>
         </section>
       </div>
     </div>

diff --git a/docs/Artificial Intelligence Agents.html b/docs/Artificial Intelligence Agents.html
@@ -17,7 +17,7 @@
       <div class="content-wrapper">
         <p>
           <a href="index.html">The Costumemaster</a>
-          <span class="no-mobile"> (100% documented)</span>
+          <span class="no-mobile"> (98% documented)</span>
         </p>
 
         <p class="header-right">
@@ -502,10 +502,10 @@ <h4>Declaration</h4>
                   <a href="Structs/AIStateRecordable.html">AIStateRecordable</a>
                 </li>
                 <li class="nav-group-task">
-                  <a href="Structs/GameLevelItem.html">GameLevelItem</a>
+                  <a href="Structs/AchievementEntry.html">AchievementEntry</a>
                 </li>
                 <li class="nav-group-task">
-                  <a href="Structs/GamePreferences.html">GamePreferences</a>
+                  <a href="Structs/GameLevelItem.html">GameLevelItem</a>
                 </li>
               </ul>
             </li>
@@ -514,8 +514,8 @@ <h4>Declaration</h4>
       </div>
       <div class="footer-wrapper">
         <section id="footer">
-          <p>&copy; 2020 <a class="link" href="https://marquiskurt.net" target="_blank" rel="external">Marquis Kurt</a>. All rights reserved. (Last updated: 2020-11-18)</p>
-          <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
+          <p>&copy; 2021 <a class="link" href="https://marquiskurt.net" target="_blank" rel="noopener" rel="external">Marquis Kurt</a>. All rights reserved. (Last updated: 2021-09-26)</p>
+          <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="noopener" rel="external">jazzy ♪♫ v0.14.0</a>, a <a class="link" href="https://realm.io" target="_blank" rel="noopener" rel="external">Realm</a> project.</p>
         </section>
       </div>
     </div>
-Original file line number
+Diff line change
@@ Expand Up / @@ -160,7 +160,7 @@ extension MainMenuScene { @@
                 sceneViewController.presentAsSheet(gameCenterController)
             }
         }
         private func reloadedAction() {
             AppDelegate.showReloadedPrompt()
         }
@@ Expand Down @@