|
| 1 | +# ANSI Commission - Design Thoughts |
| 2 | + |
| 3 | +Thanks for getting back to me! I'm excited to collaborate as I'm a fan of your work. |
| 4 | + |
| 5 | +## Legal/Licensing/Other |
| 6 | + |
| 7 | +### 1. License |
| 8 | + |
| 9 | +`pokesay` is licensed under the BSD-3-Clause license, which allows the code to be used in both open-source and proprietary software, provided that the original copyright notice and license terms are included (https://github.com/tmck-code/pokesay?tab=BSD-3-Clause-1-ov-file). |
| 10 | + |
| 11 | +I'm happy to add a separate license for the artwork that does not allow it to be reused in this manner, if you'd like? Let me know your thoughts. |
| 12 | + |
| 13 | +### 2. Monetization |
| 14 | + |
| 15 | +`pokesay` is free, and will remain free forever. It's a passion project for me, and I don't intend to monetize it in any way, so I wouldn't be making any money off of your artwork. |
| 16 | + |
| 17 | +### 3. Attribution |
| 18 | + |
| 19 | +I'm happy to include your artist name/signature in all artworks that you provide, as well as in the README and documentation for the project. |
| 20 | + |
| 21 | +### 4. Distribution |
| 22 | + |
| 23 | +- `pokesay` is distributed via GitHub, aur (arch linux) and homebrew (macOS). These binaries/release files would include your artwork. |
| 24 | +- The artwork would also be viewable on the GitHub README page. |
| 25 | + |
| 26 | +Please let me know if you have any concerns or thoughts about this. |
| 27 | + |
| 28 | +## Technical considerations |
| 29 | + |
| 30 | +The `pokesay` binary runs on Linux, macOS, Windows and Android (via Termux). Predominantly, it's used in linux terminal environments. |
| 31 | +It uses ASCII and UTF-8 chars with ANSI escape codes to display the pokemon sprites in the terminal, as well as borders for the speech bubbles and info box. |
| 32 | + |
| 33 | +Ideally, the artwork would need to be in UTF-8 format if possible? I know that many ANSI artists use the CP437 character set which isn't compatible, is it an issue to create the art in UTF-8 instead? |
| 34 | +It's not a deal-breaker if so, I can convert it to UTF-8 using durdraw, but sometimes the conversion isn't perfect so would prefer to have the artwork in UTF-8 if possible. |
| 35 | + |
| 36 | +## Design thoughts |
| 37 | + |
| 38 | +### 1. The title |
| 39 | + |
| 40 | +I'd love some text that says "pokesay" |
| 41 | +- it can either upper or lower case, whichever you think looks best |
| 42 | +- it would be displayed by the `pokesay` program in the terminal when a special arg is provided (e.g. `pokesay --title` or `pokesay --demo`) |
| 43 | +- I'd also display a screenshot of this at the top of the GitHub README page, replacing the current one that I just made with figlet |
| 44 | +- I like many of the colourful designs that you do. In terms of the palette/font to use, I'd rather avoid any potential legal issues with Nintendo, so |
| 45 | + - _some_ yellow and blue would be nice, as it would match the original pokemon colours. |
| 46 | + - but it shouldn't be _only_ yellow and blue |
| 47 | + - The font should be different to the original pokemon font |
| 48 | + |
| 49 | +#### Examples |
| 50 | + |
| 51 | +I gathered some of my favourite examples that you've done for coloured titles and demo'd what they'd look like in `pokesay` below. There are installation instructions in the README and you could use it to test out your designs, if that's helpful. |
| 52 | + |
| 53 | +>[!NOTE] _I used durdraw to convert the .ANS file to UTF-8, however it has a few problems with the ansi codes. I tried to fix them up manually but it was too much effort to fully fix the SK!BULL.ANS one. Just letting you know that it's not `pokesay` that's doing this._ |
| 54 | +
|
| 55 | +| example 1 | example 2 | example 3 | |
| 56 | +|-----------|-----------|-----------| |
| 57 | +|  _[FILES.BBS](https://16colo.rs/pack/l0p17_02/FILES.BBS)_ |  _[sk!lazarus.ans](https://16colo.rs/pack/laz17/sk%21lazarus.ans)_ |  _[SK!BULL.ANS](https://16colo.rs/pack/l0p03_99/SK%21BULL.ANS)_ | |
| 58 | +|  https://16colo.rs/pack/l0p24_08/sk%21bash.asc |  https://16colo.rs/pack/caz-01/SK%21CAZ2.ASC |  https://16colo.rs/pack/l0p10_01/SK%21ASC01.ASC | |
| 59 | + |
| 60 | +### 2. The help doc |
| 61 | + |
| 62 | +I have both a manpage and `--help` output for the program that lists all of the available args and options. |
| 63 | +This art would be displayed when the user runs `pokesay --help`. It currently looks like this: |
| 64 | + |
| 65 | + |
| 66 | + |
| 67 | +The current manpage looks like this: |
| 68 | + |
| 69 | + |
| 70 | + |
| 71 | +- I'd like the title to be non-coloured |
| 72 | + - I'd also like it to be different from the font used in the title art above |
| 73 | + - I like a lot of the titles that you do that are in the style of the 'SK!MF.TXT' example below |
| 74 | +- Some colour in the help section underneath would be nice, like the `SK!MENU.ANS` example below |
| 75 | +- Some titles separating the different doc sections would be good, like in the `SK!MF.TXT` example below |
| 76 | +- The `--help` docs currently only show the command-line arguments. I'd like to add more sections to it from the manpage like "Examples" |
| 77 | + |
| 78 | +TL;DR, something like the title from `SK!MF.TXT` for the top, some section titles from that same file, and some colourful CLI arg descriptions from `SK!MENU.ANS` in the top section. |
| 79 | + |
| 80 | +| example 1 | example 2 | |
| 81 | +|-----------|-----------| |
| 82 | +| https://16colo.rs/pack/l0p14_02/SK%21MENU.ANS  | https://16colo.rs/pack/l0p19_03/SK%21MF.TXT  | |
0 commit comments