Advent Of Code

This is just a personal repo for puzzles of https://adventofcode.com.

Contains helper scripts to automatically download, organize and run a puzzle by simply giving a year, a day and a lang in the CLI.

Get started

• Prepare a puzzle solution: bin/new.sh 2023 1 py

  • Also get the user input: bin/new.sh 2023 1 py --get (Requires authentication)

• Run a puzzle solution: bin/run.sh 2023 1 py

  • in debug mode: bin/run.sh 2023 1 py -d
  • using default example: bin/run.sh 2023 1 py -e
  • using a specific example: bin/run.sh 2023 1 py -E 1 (example_1)
  • using a specific example: bin/run.sh 2023 1 py -E 1a (example_1a)

Simpler execution

To make scripts execution even simpler, create a script named aoc and make sure it is in your PATH (For example, put it in ~/.local/bin/)

usage="USAGE: aoc (run|new) ..."
subcmd="$1"; shift
case "$subcmd" in
        run)    absolute/path/to/adventofcode/bin/run.sh $@ ;;
        new)    absolute/path/to/adventofcode/bin/new.sh $@ ;;
        *)      echo "$usage"; exit 1 ;;
esac

Requirements:

• Python 3.10 is required to execute python solutions

• Golang 1.21 is required to execute go solutions

• Rustc 1.68 is required to execute rust solutions

• Ocaml 5.0 is required to execute ocaml solutions

• You need to setup the .cookie file to be able to download the user-specific input from https://adventofcode.com.

  • If not done already, create an account on https://adventofcode.com
  • Authenticate on the website
  • inspect requests
  • retrieve the Cookie header
  • paste it in the .cookie file

Project structure

Organization of files related to working on a puzzle

  ├── bin
  │   ├── new.sh    Prepare a puzzle
  │   └── run.sh    Execute a puzzle solution
  │
  ├── inputs
  │   └── year_<year>
  │       │
  │       │    Example files. Must be created manually.
  │       │
  │       ├── day_<0n>_example.txt         Default example name
  │       ├── day_<0n>_example_1.txt       Default for part 1 (Uses base default if missing)
  │       ├── day_<0n>_example_2.txt       Default for part 2 (Uses base default if missing)
  │       ├── day_<0n>_example_<id>.txt    Additional example names can be used from the CLI
  │       │
  │       │    User specific input files. May be downloaded from adventofcode.com (auth required).
  │       │
  │       └── day_<0n>.txt       (Not tracked in git, as requested in the FAQ)
  │
  ├── src
  │   └── <lang>
  │       └── year_<year>
  │           │
  │           ├── template_base   May be used as a year entry point for some languages
  │           ├── template_day    May be written to speedup initialization of a puzzle
  │           │
  │           └── day_<0n>.<ext>    Automatically created, using the language's template if available
  │
  └── .cookie       (Not tracked in git)