.readme

# supcode

<!--
will putting this here
confuse you
altho tbh the probability
that someone finds this
is astronomically low
-->

<div align="center">

![supcode title card](assets/supcode-title.png)

A modern, high-level, feature-rich general-purpose programming language.

[site<sup>↗</sup>](https://sup2point0.github.io/supcode) \ [walkthrough](resources/supcoda/) \ [docs](docs/) \ [reddit<sup>↗</sup>](https://reddit.com/r/supcode) \ [Nova](resources/Nova)

</div>

---

![glimpse into supcode](assets/supcode-glimpse.png)


<br>


## Features

 - Intuitive keyword-focused syntax
 - Object-oriented and dynamically typed
 - `kebab-case` in identifiers for maximum readability
 - Clean and easy modularisation and path resolution
 - Flexible with configurations and flavours
 - Versatile with extensions and frameworks
 - Purely conceptual – you can’t write a single bug if the code doesn’t run!


## Explore

> [!TIP]
> For the best first viewing experience, check out the [supcode site<sup>↗</sup>](https://sup2point0.github.io/supcode)!

Want to see more of supcode? We’ve got a huge array of [specimens](specimens/).

Looking to learn the language? The [*supcoda*](resources/supcoda/) is a full walkthrough.

Instant question? There’s a good chance it’s answered in [FAQ](faq.md).

![another glimpse into supcode](assets/supcode-glimpse-another.png)


## Info

<table>
  <tr>
    <th colspan="2"> <h3> supcode 5.0 </h3> </th>
  </tr>
  <tr>
    <td> official name </td>
    <td> supcode </td>
  </tr>
  <tr>
    <td> format </td>
    <td> text-based </td>
  </tr>
  <tr>
    <td> level </td>
    <td> <a href="https://wikipedia.org/wiki/High-level_programming_language">high-level</a> </td>
  </tr>
  <tr>
    <td> <a href="https://wikipedia.org/wiki/Execution_(computing)">execution</a> </td>
    <td> <a href="https://wikipedia.org/wiki/Interpreter_(computing)">interpreted</a> </td>
  </tr>
  <tr>
    <td> <a href="https://wikipedia.org/wiki/Programming_paradigm">paradigm</a> </td>
    <td> <a href="https://wikipedia.org/wiki/Imperative_programming">imperative</a>, <a href="https://en.m.wikipedia.org/wiki/Object-oriented_programming">object-oriented</a>, <a href="https://wikipedia.org/wiki/Event-driven_programming">event-driven</a> </td>
  </tr>
  <tr>
    <td> purpose </td>
    <td> <a href="https://wikipedia.org/wiki/General-purpose_programming_language">general-purpose</a> </td>
  </tr>
  <tr>
    <td> syntax </td>
    <td> human-friendly – readable, intuitive, keyword-focused </td>
  </tr>
  <tr>
    <td> <a href="https://wikipedia.org/wiki/Type_system">type</a> </td>
    <td> <a href="https://wikipedia.org/wiki/Type_system#DYNAMIC">dynamic</a> </td>
  </tr>
  <tr>
    <td> indentation </td>
    <td> <a href="https://wikipedia.org/wiki/Off-side_rule">significant</a> (pre-6.0) <br> <a href="https://en.m.wikipedia.org/wiki/Free-form_language">insignificant</a> (post-6.0) </td>
  </tr>
  <tr>
    <td> <a href="https://wikipedia.org/wiki/Operating_system">platform</a> </td>
    <td> any </td>
  </tr>
  <tr>
    <td> based on </td>
    <td> <a href="https://scratch.mit.edu">Scratch</a>, <a href="https://python.org">Python</a> </td>
  </tr>
  <tr>
    <td> inspired by </td>
    <td> <a href="https://mediawiki.org/wiki/Wikitext">Wikitext Markup</a>, <a href="https://swift.org">Swift</a>, C#, HTML </td>
  </tr>
  <tr>
    <td> <a href="https://wikipedia.org/wiki/Filename_extension">filename extensions</a> </td>
    <td> <code>.sc</code>, <code>.sc6</code> <code>.sc5</code>, <code>.scx</code> </td>
  </tr>
  <tr>
    <td> other extensions </td>
    <td> <code>.scd</code>, <code>.scp</code>, <code>.scv</code>, <code>.scl</code>, <code>.scs</code>, <code>.scg</code> </td>
  </tr>
  <tr>
    <td> main <a href="https://wikipedia.org/wiki/Flavors_(programming_language)">flavour</a> </td>
    <td> <a href="source/syntax.md#utinax">Utinax One</a> </td>
  </tr>
  <tr>
    <td> other flavours </td>
    <td> <a href="source/syntax.md#veritinax">Veritinax One</a>, <a href="source/syntax.md#resinax">Resinax 1.6</a> </td>
  </tr>
  <tr>
    <td> initial release </td>
    <td> September 2021 </td>
  </tr>
  <tr>
    <td> founder </td>
    <td> <a href="https://github.com/Sup2point0">Sup#2.0</a> </td>
  </tr>
  <tr>
    <td> developer </td>
    <td> 2.0 Studios (2.0 Studios LLC) </td>
  </tr>
  <tr>
    <td> <a href="https://wikipedia.org/wiki/Integrated_development_environment">IDEs</a> </td>
    <td> <a href="suplus/supcode%20Studio">supcode Studio</a>, <a href="suplus/supcode%20Studio/supcode%20Studio%20Strium">supcode Studio Strium</a> </td>
  </tr>
  <tr>
    <td> latest release </td>
    <td> 5.7 (July 2023) <br> 6.0 (upcoming) </td>
  </tr>
</table>


## Contributing

Feedback, thoughts and criticism are absolutely welcome! Just drop something in [issues]() or [discussions]().


## Roadmap

 - [ ] site
 - [ ] *supcoda*
 - [x] *Learn supcode in Y minutes*
 - [x] PrismJS syntax highlighter


## About

Made with love by Sup#2.0 ([@Sup2Point0]()).

On ? September 2021, I sent a code file written in a hypothetical programming language to my friend, just as a joke. What d’y’know, a joke develops until it becomes reality, and supcode was born. Development subsequently kicked off, with 3 major revisions of the language, before we reached stability with supcode 4.0.

supcode draws upon each and every coding language I’ve worked with – primarily Scratch, Python and Wikitext Markup. Its original intention was to act as a bridge between the block-based syntax of Scratch and text-based syntax of real code, although the language has ~~deteriorated~~ developed too far for this vision to remain accurate. Above all, it aims to be fun, unique and dynamic.

I’ve placed all this work under the MIT license, but in the unlikely case that anyone would like to use any of it, credit would be appreciated.

Enjoy!


<br>


## Specimens

### supcode 6.0

> [!Note]
> *supcode 6.0* is currently under development.

```coffee
<sup ver="6" sty="utinax-vis" ind=3>
\\
DISCLAIMER –
This code is only a peek at what supcode can do.
It is not by any means functional, optimised or perfect.
Enjoy ^v^
\\

<sec 'structs'>
create struct 'profile' {
   \\
      Represents a user profile.
   \\

   evolve action create self(ctx) [
     | int 'id'
     | str 'user', 'name'
     | str, list(str) 'alts' = none
     | list(str) 'langs' = list()
     | list(str) 'apts' = list()
     | (par)s 'pars'
   ] {
      \\
         Creates a new profile.
      \\

      auto set id, name, alt-name, langs, apts

      set self.'render-keywords' = dict(
         "id" = "User ID",
         "name" = "Username",
         "alts" = "Alternative Usernames",
         "langs" = "Programming Languages",
         "apts" = "Aptitudes",
      )

      loop for key, val in pars {
         set self.(shard(key)) = val
      }
   }

   create func self.render-text() to str {
      set 'text' = "Profile[" + "\n"

      loop for 'var' in self._vars_ {
         if var in self.render-keywords {
            alt text + "`render-keywords # var`: "
         } else {
            alt text + str(var) + ": "
         }

         alt text + { if var is iterable then {
            str.join(
               { for each in var out str(each) }
            ) [sep = ", "]
         } else str(var) }
      }

      out text
   }
}
</sec>

<sec "core">
evolve sys.run(ctx) [(par)s]
{
   set 'sup' = profile() [
      | id = 2.0
      | name = "Sup#2.0"
      | alt-name = "Sup2point0"
      | langs = "supcode", "Scratch", "Python", "C#", "HTML", "CSS", "JavaScript",
      | apts = (
         "creating", "designing", "coding", "procrastinating",
      )
   ]

   sys.out(sup.render-text())
   sys.in()
   sys.quit()
}
</sec>

\ how’d you like that?
</sup>
```

### supcode 5.7

```coffee
\ supcode 5.7

create struct 'SoupMachine' {
  evolve func self.create(ctx) [
    | num 'cost'
    | str 'name' = none
    | (str)s 'flavours' = ()
  ] {
    set self.'cost' = cost
    set self.'name' = { if name then name else ctx.shard.str }
    set self.'flavours' = { loop for each in flavours || case(each)[lower] }
  }
  
  define self.purchase() [
    | source
    | int 'count' = 1
    | pool[self.flavours] 'flavour' = none
  ] {
    if count < 1 {
      evoke "Can’t give that many bowls of soup!"
    }
    
    if not flavour {
      set 'flavour' = random(self.flavours)[option]
    }
    
    alt source - self.cost * count
    func.out("Here’s some flavour` soup!")
  }
}

set 'credits' = 200
set 'soupy' = SoupMachine() [
  | cost = 20
  | flavours = "tomato", "mushroom", "potato"
]

sys.out(soupy.purchase(credits, 1, "mushroom"))
```

<!-- sup :v -->