Merge pull request #41 from Geyserexe/dev-4

Dev 4

LICENSE

@@ -1,21 +1,9 @@
 MIT License
 
-Copyright (c) 2020 Geyserexe
+Copyright (c) 2023 Geyserexe
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1,28 +1,28 @@
 # BuilderBot
-A program to build teams for Pokemon Showdown in the gen8nationaldexag, gen8anythinggoes & gen7anythinggoes formats
+A program to build teams for Pokemon Showdown in the gen8anythinggoes & gen7anythinggoes formats
 
 Use config.cutoff to change the building style by changing it between 0 and 10.  Lower cutoffs result in more offensive teams that are less likely to have effective meta checks, while higher cutoffs generally result in bulkier teams. 
 Add additional sets to the appropriate file in src/sets/. 
 In order to run the teambuilder, open Terminal / cmd, cd into the builderbot file, and run "node builder".
 
-- Note: dev branch may be unreliable / produce really bad teams
+- Note: dev branch may be unreliable / produce really bad teams.
 - If you're using this on repl.it, run "npm install" in the console to the right to set it up, followed by "node builder" to build teams.
 
 ## Flags ##
 
 "node builder" can be run with each of the following flags, which are added after the command, each of which override anything in config.json.
 
-an example of flag usage is "node builder --t gen8nationaldexag --c 7 --r 14 --a chansey,groudon-primal"
+an example of flag usage is "node builder --t gen7anythinggoes --c 7 --r 14 --a chansey,groudon-primal"
 
 - --c controls the cutoff variable.
 - --t controls the tier built for.
-- --m controls the mode (offense / balance / stall) built for.
+- --m controls the mode (offense / balance) built for.
 - --b controls the breakerThreshold value.
 - --r controls the recurseThreshold value.
 - --n controls the number of teams built.
 - --a controls the avoided mons; formatting is a comma-separated-list.
 - --cm turns on core mode.
-- --d runs the builder on the default settings (i.e galar balance cutoff 5 bT 25 rT 10 etc) and overrides any other settings.
+- --d runs the builder on the default settings (i.e galar balance cutoff 5 bT 35 rT 15 etc) and overrides any other settings.
 - --raw makes the builder output the team as text rather than as a pokepaste link.
 - --nsc deactivates species clause, allowing duplication of Pokemon, excluding those that are illegal in-game.
 
@@ -31,13 +31,12 @@ an example of flag usage is "node builder --t gen8nationaldexag --c 7 --r 14 --a
 - "teamNumber" controls the number of teams built.  Whenever multiple teams are built, they'll be exported in a bulk format.
 - "cutoff" controls the threshold at which the builder will allow a given pokemon onto a team, resulting in potentially less reliable builds at lower levels, but overly similar builds at higher levels.  Cutoff 10 is likely to result in glitchy or inconsistent building.
 - "teamLength" controls the number of Pokémon in a team, on the off chance that you want more / fewer than 6
-- "tier" controls the tier being built for.  Current options are gen8anythinggoes, gen7anythinggoes and gen8nationaldexag.
-- "mode" controls what type of teams the builder will create.  Current options are balance, offense, and stall.
-- "coreMode" controls whether or not the builder uses an experimental, currently natdex-only, building mode where the team starts with a pre-chosen set of 3 Pokémon.
+- "tier" controls the tier being built for.  Current options are gen8anythinggoes, gen7anythinggoes.
+- "mode" controls what type of teams the builder will create.  Current options are balance and offense.
 - "breakerThreshold" is the minimum value for the breaker stat below which the builder will rebuild a team.  Higher values lead to more offensive teams, potentially to the detriment of the other stats.  Low values will not necessaily lead to correspondingly reduced offensive presence.  This feature is balance-only.
-- "recurseThreshold" is the minimum value for a given stat below which the builder will rebuild a team.  If this value is set too high, an error will likely appear.  Higher values will lead to better teams, but only up to a point, beyond which teams may appear overly similar.  Optimal values for this field are integers between 10 and 20.  This feature does nothing if teamNumber is greater than 1, owing to stack size limitations.  This feature applies only to balance and stall.
+- "recurseThreshold" is the minimum value for a given stat below which the builder will rebuild a team.  If this value is set too high, an error will likely appear.  Higher values will lead to better teams, but only up to a point, beyond which teams may appear overly similar.  Optimal values for this field are integers between 10 and 20.  This feature does nothing if teamNumber is greater than 1, owing to stack size limitations.  This feature applies only to balance.
 - "monsToAvoid" allows the user to decide if there are certain Pokémon that they do not want on their team.  Commonly used options are Chansey or Diancie.  Formatting within the [] is "mon","mon","mon", etc.  This field is not case-sensitive.
-- "startMon" allows the user to provide a set around which to build a team.  The set should be formatted as below for galar dex AG.  For gen7 or natdex, the formatting can be found in the gen7 sets or natdex sets file.  "__check" information is optional, but should be incuded for best results.
+- "startMon" allows the user to provide a set around which to build a team.  The set should be formatted as below for galar dex AG.  For gen7, the formatting can be found in the gen7 sets file.  "__check" information is optional, but should be incuded for best results.
 
 #### Set Formatting ####
 
@@ -52,22 +51,19 @@ an example of flag usage is "node builder --t gen8nationaldexag --c 7 --r 14 --a
      },
     "breaker":,
     "ogreCheck":,
-    "ygodCheck":,
     "xernCheck":,
     "zygCheck":,
-    "zacCheck":,
     "calyCheck":,
     "rocks":,
     "defog":
 }
 
-All fields between "breaker" and "zacCheck" should be integers between 0 and 10.  "rock" and "defog" should be booleans.  An optional "cleric": true field can be added after "defog", in the event of cleric use.  This format can be used for both the "startMon" field in config.js or for any of the three natdex sets files.  Gen7 set files use a slightly different format, which can be found in either gen7sets.json or gen7leads.json
+All fields between "breaker" and "calyCheck" should be integers between 0 and 10.  "rock" and "defog" should be booleans.  An optional "cleric": true field can be added after "defog", in the event of cleric use.  This format can be used for both the "startMon" field in config.js.  Gen7 set files use a slightly different format, which can be found in either gen7sets.json or gen7leads.json
 
 #### File-Structure Info ####
 
-All builder and set files are located within "src".  You shouldn't touch the .gitignore, package.json, or package-lock.json unless you really know what you're doing.  Honestly, you probably shouldn't touch any of it outside of the set files or config file.
+All builder and set files are located within "src".  You shouldn't touch the .gitignore, package.json, or package-lock.json unless you really know what you're doing.  Honestly, you probably shouldn't touch any of it outside of the set files or config file because most of it is a sketchy house of cards that'll collapse quickly.
 
 #### TODO ####
 
-- Add gen6 support
-- Update Natdex building for post-dlc metan
+- Add gen9 support

config.json

@@ -7,23 +7,8 @@
             "tier": "gen8anythinggoes",
             "mode": "balance",
             "coreMode": false,
-            "breakerThreshold": 25,
-            "recurseThreshold": 10,
-            "monsToAvoid": [
-                ""
-            ],
-            "startMon": {},
-            "speciesClause": true
-        },
-        "stall": {
-            "teamNumber": 1,
-            "cutoff": 7,
-            "teamLength": 6,
-            "tier": "gen8anythinggoes",
-            "mode": "stall",
-            "coreMode": false,
-            "breakerThreshold": 0,
-            "recurseThreshold": 8,
+            "breakerThreshold": 30,
+            "recurseThreshold": 15,
             "monsToAvoid": [
                 ""
             ],
@@ -40,7 +25,7 @@
             "breakerThreshold": 35,
             "recurseThreshold": 0,
             "monsToAvoid": [
-                ""
+                "Kyogre"
             ],
             "startMon": {},
             "speciesClause": true
@@ -62,21 +47,6 @@
             "startMon": {},
             "speciesClause": true
         },
-        "stall": {
-            "teamNumber": 1,
-            "cutoff": 7,
-            "teamLength": 6,
-            "tier": "gen7anythinggoes",
-            "mode": "stall",
-            "coreMode": false,
-            "breakerThreshold": 0,
-            "recurseThreshold": 8,
-            "monsToAvoid": [
-                ""
-            ],
-            "startMon": {},
-            "speciesClause": true
-        },
         "offense": {
             "teamNumber": 1,
             "cutoff": 7,
@@ -92,52 +62,5 @@
             "startMon": {},
             "speciesClause": true
         }
-    },
-    "gen8nationaldexag": {
-        "balance": {
-            "teamNumber": 1,
-            "cutoff": 7,
-            "teamLength": 6,
-            "tier": "gen8nationaldexag",
-            "mode": "balance",
-            "coreMode": false,
-            "breakerThreshold": 20,
-            "recurseThreshold": 11,
-            "monsToAvoid": [
-                ""
-            ],
-            "startMon": {},
-            "speciesClause": true
-        },
-        "stall": {
-            "teamNumber": 1,
-            "cutoff": 7,
-            "teamLength": 6,
-            "tier": "gen8nationaldexag",
-            "mode": "stall",
-            "coreMode": false,
-            "breakerThreshold": 0,
-            "recurseThreshold": 9,
-            "monsToAvoid": [
-                ""
-            ],
-            "startMon": {},
-            "speciesClause": true
-        },
-        "offense": {
-            "teamNumber": 1,
-            "cutoff": 6,
-            "teamLength": 6,
-            "tier": "gen8nationaldexag",
-            "mode": "offense",
-            "coreMode": false,
-            "breakerThreshold": 40,
-            "recurseThreshold": 0,
-            "monsToAvoid": [
-                ""
-            ],
-            "startMon": {},
-            "speciesClause": true
-        }
     }
 }