Skip to content
Permalink
Browse files

Documentation cleanup and reorganization

  • Loading branch information
esauvisky committed Oct 21, 2019
1 parent c8cd2ab commit 5a2fdc0d17dc67ad43d55fe35b9a1ae290d049f5
Showing with 410 additions and 218 deletions.
  1. +22 −17 docs/{actions/ACTIONS.md → SORTING.md}
  2. +0 −10 docs/actions/add-to-calcy.yaml
  3. +0 −6 docs/actions/modular-config/README.md
  4. +0 −39 docs/actions/modular-config/config.yaml
  5. +0 −16 docs/actions/modular-config/config/pokemons/metarelevant.yaml
  6. +5 −0 docs/config-examples/README.md
  7. +20 −0 docs/config-examples/add-to-calcy.yaml
  8. +10 −0 docs/config-examples/modular-config/README.md
  9. +48 −0 docs/config-examples/modular-config/config.yaml
  10. +7 −25 docs/{actions → config-examples}/modular-config/config/actions/alt.yaml
  11. +53 −0 docs/config-examples/modular-config/config/actions/costume.yaml
  12. +113 −86 docs/{actions → config-examples}/modular-config/config/actions/default.yaml
  13. 0 docs/{actions → config-examples}/modular-config/config/actions/prettify.yaml
  14. +3 −0 docs/config-examples/modular-config/config/actions/replace.yaml
  15. +15 −11 docs/{actions → config-examples}/modular-config/config/actions/shiny.yaml
  16. 0 docs/{actions → config-examples}/modular-config/config/actions/templates/basic_rename_all.yaml
  17. 0 docs/{actions → config-examples}/modular-config/config/actions/templates/basic_scan_only.yaml
  18. 0 docs/{actions → config-examples}/modular-config/config/actions/templates/basic_unrename_all.yaml
  19. 0 docs/{actions → config-examples}/modular-config/config/actions/traded.yaml
  20. 0 docs/{actions → config-examples}/modular-config/config/actions/unown.yaml
  21. 0 docs/{actions → config-examples}/modular-config/config/calcy/prettify.properties
  22. 0 docs/{actions → config-examples}/modular-config/config/calcy/shiny.properties
  23. +75 −0 docs/config-examples/modular-config/config/char-length.py
  24. 0 docs/{actions → config-examples}/modular-config/config/locations/oneplus6.yaml
  25. 0 docs/{actions → config-examples}/modular-config/config/locations/pixel.yaml
  26. 0 docs/{actions → config-examples}/modular-config/config/locations/pixel1080x2200.yaml
  27. 0 docs/{actions → config-examples}/modular-config/config/locations/pixel1080x2400.yaml
  28. 0 docs/{actions → config-examples}/modular-config/config/locations/redmi-nobar.yaml
  29. +2 −2 docs/{actions → config-examples}/modular-config/config/locations/redmi.yaml
  30. 0 docs/{actions → config-examples}/modular-config/config/locations/redmi1080x2400.yaml
  31. 0 docs/{actions → config-examples}/modular-config/config/pokemons/babies.yaml
  32. 0 docs/{actions → config-examples}/modular-config/config/pokemons/blacklist.yaml
  33. 0 docs/{actions → config-examples}/modular-config/config/pokemons/evolve.yaml
  34. 0 docs/{actions → config-examples}/modular-config/config/pokemons/legendaries.yaml
  35. +22 −0 docs/config-examples/modular-config/config/pokemons/metarelevant.yaml
  36. 0 docs/{actions → config-examples}/modular-config/config/pokemons/pvp.yaml
  37. +7 −1 docs/{actions → config-examples}/modular-config/config/pokemons/rares.yaml
  38. +0 −1 docs/{actions → config-examples}/modular-config/config/pokemons/trade_candy.yaml
  39. 0 docs/{actions → config-examples}/modular-config/config/pokemons/trade_candy_alt.yaml
  40. 0 docs/{actions → config-examples}/modular-config/config/waits/pixel.yaml
  41. +2 −2 docs/{actions → config-examples}/modular-config/config/waits/redmi.yaml
  42. 0 docs/{actions → config-examples}/rename-all.yaml
  43. +4 −1 docs/{actions → config-examples}/ridiculously-complex-config.yaml
  44. 0 docs/{actions → config-examples}/shiny-rename.yaml
  45. +2 −1 docs/{actions → config-examples}/unrename-all.yaml
@@ -1,16 +1,10 @@
# ACTIONS Examples
# Sorting Table

**This folder contains several actions examples, from the very simple ones to ridiculously complicated.**
**This is the order in which Pokemon displays pokémons when sorting by A-Z.** Useful for working out a custom order you'd like to view your pokémons, by using these characters at the beginning of the `rename:` action.

Use them as is, or as guideline to build your own config.yaml.
>_For Gboard users, the character in parenthesis indicates which key on Gboard contains the character in question (with tap&hold)._
To use them, replace all your `actions:` block with one of these, with careful not to replace the following block, `iv_regexes`.

## Sorting Table

**This is the order in which Pokemon displays pokémons when sorting by A-Z. Useful for working out a custom order you'd like to view your pokémons.**

_For Gboard users, the character in parenthesis indicates which key on Gboard contains the character in question (with tap&hold)._
>_For very advanced users, **like the ones who would adventure themselves into [modular-config](./config-examples/modular-config/)**, check out [True character length](#True%20character%20length) section below._
- `꩜ ` _(Special @. Not available on Gboard)_
- `!`
@@ -47,7 +41,8 @@ _For Gboard users, the character in parenthesis indicates which key on Gboard co
- `↓` _(Inside key `^`)_
- `←` _(Inside key `^`)_
- `⇆` _(Double Arrow. Not available on Gboard)_
- `μ` _(Inside key `π`)_ [B]
- `μ` _(Inside key `π`)_ **[B] Needs Confirmation!**
- `®`
- `·` _(Inside key `-`)_
- `†` _(Inside key `*`)_
- `‡` _(Inside key `*`)_
@@ -59,29 +54,39 @@ _For Gboard users, the character in parenthesis indicates which key on Gboard co
- `♣` _(Inside key `•`)_
- `♥` _(Inside key `•`)_
- `♦` _(Inside key `•`)_
- `♪` _(Inside key `•`)_
- `✂️` (Emoji)
- `✓`
- `€`
- `∞` _(Inside key `=`)_ [B]
- `∞` _(Inside key `=`)_ **[B] Needs Confirmation!**
- Numbers
- `∞` _(Inside key `=`)_ [A]
- `∞` _(Inside key `=`)_ **[A] Needs Confirmation!**
- Letters
- `μ` _(Inside key `π`)_ [A]
- `μ` _(Inside key `π`)_ **[A] Needs Confirmation!**
- `Π` _(Inside key `π`)_
- `π`
- `Ω` _(Inside key `π`)_

___

### Per device differences


**TODO: Confirm if this is still an issue.**

**Characters above with `[A]` or similar at the end means that the order changes depending on the device. Yeah...**
The letter between the brackets is the device's "type" _(more like mood)_, so if your phone follows pattern [A], you should disregard characters labeled as [B].

---

## True character length

The letter between the brackets is the device's "type" _(more like mood)_, so if your phone follows pattern [A], you should disregard characters labeled as [B]. In other words, it's either one, or the other.
**If you _used_ to get lots of _Please choose another pokemon name_ when renaming, that means that some of your symbols are too big, and the string is exceeding 12 characters.** Though it might look like the name is 12-characters long, some characters are actually composed of several unicode elements (like Emojis, for example, which are usually a combination of three separate characters), making them bigger than they appear, and thus making PoGo think you're trying to set a too big of a name.

PoGo-CalcaBotaBotaCalca deals with this by doing several tricks if the character name's going to exceed 12 characters:

### True character length:
-

**If you get lots of _Please choose another pokemon name_ when renaming, that means that some of your symbols are too big, and the string is exceeding 12 characters. Though they might look like the occupy a single space, they're actually composed of several unicode elements, making them bigger than they appear, and thus making PoGo unhappy.**

**Below follows a list with each character *true length* from the list above.**

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

@@ -0,0 +1,5 @@
# ACTIONS Examples

**This folder contains several actions examples, from some [very simple ones](./unrename-all.yaml) to the [unecessary complicated](./ridiculously-complex-config.yaml)... and [worse.](./modular-config/).**

Use them as is, or as guideline to build your own config.yaml.
@@ -0,0 +1,20 @@
## This action block does nothing, it just populates your CalcyIV history with
## all your pokémon. If you want to save them automatically as well, activate the
## option "Save Appraised Pokémon" and uncomment (remove the #) at lines 19 and 20.

## You could also set Calcy to save any and every scanned pokémon, in advanced settings,
## though I'd strongly advise you then set --max-retries=1, otherwise the chance of
## getting false duplicates (or even triplicates) is very high.

actions:
# Failed scans get renamed for later verification
- conditions:
success: false
actions:
rename: "!ManualCheck"

# Successful scans are skipped.
- conditions:
success: true
# - actions:
# appraise:
@@ -0,0 +1,10 @@
MODULAR CONFIG
##############

**This will be always a WIP, as they are literally my own personal configs, which I update (i.e.: copy over) to the repo's docs periodically.** Don't expect nothing pretty or organized, it's just here for reference.

----

This is even more complex than the `ridiculously-complex-config.yaml` example, but allows you to easily set up different actions for different situations, quickly change between device's coords and waits, and so on.

_Also, take a look at [config.yaml](./config.yaml) first and foremost, to grasp the idea about how this works..._
@@ -0,0 +1,48 @@
#################################
## Current A-Z Ordering Scheme ##
#################################
# In theory my pokémon list should look like this.
# In practice, renaming 1.5k pokémon while dealing with
# so many issues like failed scans, deoxyses, names too
# big, and so on, it's kinda of a PITA.
# This is why I keep this list, so I never forget wtf I had in
# mind. For some reason, though, future me always blames me...

## In A-Z, the pokémon list should look like this.
## The first two characters (# ) don't count, and anything in
## parenthesis don't as well. everything else does, so if
## there's an space, it'll have an space on PoGo.
# !ToVerify/Failed/Etc
# #Defenders
# ®ShinyBabies
#
# †PVP1500
# ‡PVP2500
# ☀️Shundos (actually IV >95)
# ★Shinies
# ♠Costumes/Rares/Mythical
# ♣Collections
# ♦Legendaries
# ♪Metarelevant
# ✓Hundos

# ' ' Legacies (it's a space after the preceding character, to push it up the list of the main category)

locations:
!include config/locations/redmi.yaml


waits:
!include config/waits/redmi.yaml


blacklist:
-
#disabled because of https://github.com/Azelphur/PokemonGo-CalcyIV-Renamer/issues/47
#!include config/blacklist.yaml


## Select below which action file you'd like to use.
## *Take a look at those yamls yourself, so you understand better how they works.*
actions:
!include config/actions/shiny.yaml
@@ -26,28 +26,12 @@
actions:
appraise:

# Good legacy + legendary, prolly going to get used by alt
- conditions:
legacy: true
iv_max__ge: 90
level__ge: 30
name__in: !include ../pokemons/legendaries.yaml
actions:
favorite:
rename: "·{calcy}"
# Rest of legacy + legendary, prolly going to get traded anytime
- conditions:
legacy: true
name__in: !include ../pokemons/legendaries.yaml
actions:
favorite:
rename: "•{calcy}"
# Rest of legacies non legendary, prolly going to get traded as well
# Legacies tradeable:
- conditions:
legacy: true
actions:
favorite:
rename: '•{calcy}' # legacies non legandaries
rename: 'μ{level} TRADE' # legacies non legandaries


############
@@ -131,32 +115,30 @@
## manually checked before trading, or traded exclusively with other μ pokés.
- conditions:
level__ge: 33
lucky: false
actions:
rename: "π{level} TRADE"
rename: "μ{level} TRADE"
- conditions:
cp__ge: 2300
lucky: false
actions:
rename: "π{level} TRADE"
rename: "μ{level} TRADE"

## Babies go to main, I don't care about babies on alt, waste of space
- conditions:
name__in: !include ../pokemons/babies.yaml
actions:
rename: "π TRADE {iv_avg}"
rename: "μ TRADE {iv_avg}"

## Renames the rest of pokémons good for candies
- conditions:
name__in: !include ../pokemons/trade_candy.yaml
actions:
rename: "π{level} TRADE"
rename: "μ{level} TRADE"

## Renames the rest of pokémons good for candies
- conditions:
name__in: !include ../pokemons/trade_candy_alt.yaml
actions:
rename: "π{level} TRADE"
rename: "μ{level} TRADE"



@@ -0,0 +1,53 @@
## How to use:
# 1. Set calcy as:
# - No Moves:
# "$NaAb$$Form$$Legacy$$Perf/IV%$ $Lvl$            $CatchDate$|$Lucky$|$ATT$|$DEF$|$HP$|$Gender$|$Trade$|$IV%Min$|$IV%Max$|$AttIV$|$DefIV$|$HpIV$|$FaMove$|$SpMove$|$Appraised$|$Legacy$"
# - Moves:
# "$NaAb$$Form$$Legacy$$Perf/IV%$ $Lvl$            $CatchDate$|$Lucky$|$ATT$|$DEF$|$HP$|$Gender$|$Trade$|$IV%Min$|$IV%Max$|$AttIV$|$DefIV$|$HpIV$|$FaMove$|$SpMove$|$Appraised$|$Legacy$"
# 2. Search for:
# "costume&!shiny, eggsonly&!shiny"
# To rename costume pokemon differently
#
# TIP: You can also restore calcy's export: shiny-default.properties instead of copying and pasting the strings above.
# Be aware it's going to replace your symbols as well.


# Nobrainer:
- conditions:
success: false
actions:
rename: "! Verify"

# Appraise everyhing that's not appraised yet
- conditions:
appraised: false
actions:
appraise:

## Costume babies with hearts ...
## .... because ... babies aaaand:
## IV 100 (or really close but not possible to determine)
- conditions:
name__in: !include ../pokemons/babies.yaml
iv_max__eq: 100
appraised: true
actions:
rename: "♠♥✓{calcy}"

## Costume babies with hearts ...
## .... because ... babies.
- conditions:
name__in: !include ../pokemons/babies.yaml
actions:
rename: "♠♥{calcy}"

## IV 100 (or really close but not possible to determine)
- conditions:
iv_max__eq: 100
appraised: true
actions:
rename: "♠✓{calcy}"

# Everything else
- actions:
rename: "♠{calcy}"

0 comments on commit 5a2fdc0

Please sign in to comment.
You can’t perform that action at this time.