Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc #52

Merged
merged 2 commits into from
Nov 8, 2024
Merged

Doc #52

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c5ae05f
Minor fixes (#51)
slshen Oct 23, 2024
21e2332
Add documentation, rename package.
slshen Nov 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 19 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,19 @@
# sbs
# paperscore

*paperscore* is a hybrid paper-computer softball scoring system that I've been using for the last couple of years to score amateur travel softball games.

Some features and notes:

* The software computes a variety of batting statistics that it can export in CSV format. The CSV files can be imported into any of a number of other systems for additional analysis. Personally I've been using [hex.tech](https://hex.tech).
* The scoring notation and software support entering "alternate plays", which is a play which in the scorers opinion should have occurred. The software can compute the expected run cost of these errors and misplays.
* The scoring notation is derived from [retrosheet](https://www.retrosheet.org).
* The software is incomplete, and undoubtedly has bugs. Some of the code is experimental was just "left in" possibly to be completely later or more likely not at all.
* The error messages leave a lot to be desired. I've found myself running the code in the debugger just to figure out what the actual error was.
* There's a text UI editor for games that I find helpful.

## Sample Paper Score

Here's a sample score sheet:

![Sample Score](/doc/score.jpeg)

4 changes: 2 additions & 2 deletions cmd/alt.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ package cmd
import (
"fmt"

"github.com/slshen/sb/pkg/game"
"github.com/slshen/sb/pkg/stats"
"github.com/slshen/paperscore/pkg/game"
"github.com/slshen/paperscore/pkg/stats"
"github.com/spf13/cobra"
)

Expand Down
4 changes: 2 additions & 2 deletions cmd/batcount.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ package cmd
import (
"fmt"

"github.com/slshen/sb/pkg/game"
"github.com/slshen/sb/pkg/stats"
"github.com/slshen/paperscore/pkg/game"
"github.com/slshen/paperscore/pkg/stats"
"github.com/spf13/cobra"
)

Expand Down
6 changes: 3 additions & 3 deletions cmd/batting_times.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ import (
"fmt"
"strings"

"github.com/slshen/sb/pkg/dataframe"
"github.com/slshen/sb/pkg/game"
"github.com/slshen/sb/pkg/stats"
"github.com/slshen/paperscore/pkg/dataframe"
"github.com/slshen/paperscore/pkg/game"
"github.com/slshen/paperscore/pkg/stats"
"github.com/spf13/cobra"
)

Expand Down
6 changes: 3 additions & 3 deletions cmd/box.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ import (
"path/filepath"
"strings"

"github.com/slshen/sb/pkg/boxscore"
"github.com/slshen/sb/pkg/game"
"github.com/slshen/sb/pkg/stats"
"github.com/slshen/paperscore/pkg/boxscore"
"github.com/slshen/paperscore/pkg/game"
"github.com/slshen/paperscore/pkg/stats"
"github.com/spf13/cobra"
"gopkg.in/yaml.v3"
)
Expand Down
6 changes: 3 additions & 3 deletions cmd/dataexport.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ package cmd
import (
"fmt"

"github.com/slshen/sb/pkg/dataexport"
"github.com/slshen/sb/pkg/dataframe/pkg"
"github.com/slshen/sb/pkg/game"
"github.com/slshen/paperscore/pkg/dataexport"
"github.com/slshen/paperscore/pkg/dataframe/pkg"
"github.com/slshen/paperscore/pkg/game"
"github.com/spf13/cobra"
)

Expand Down
2 changes: 1 addition & 1 deletion cmd/fmt.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
package cmd

import (
"github.com/slshen/sb/pkg/game"
"github.com/slshen/paperscore/pkg/game"
"github.com/spf13/cobra"
)

Expand Down
2 changes: 1 addition & 1 deletion cmd/newgame.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
package cmd

import (
"github.com/slshen/sb/pkg/gamefile"
"github.com/slshen/paperscore/pkg/gamefile"
"github.com/spf13/cobra"
)

Expand Down
4 changes: 2 additions & 2 deletions cmd/pitching_times.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ package cmd
import (
"fmt"

"github.com/slshen/sb/pkg/game"
"github.com/slshen/sb/pkg/stats"
"github.com/slshen/paperscore/pkg/game"
"github.com/slshen/paperscore/pkg/stats"
"github.com/spf13/cobra"
)

Expand Down
4 changes: 2 additions & 2 deletions cmd/playbyplay.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ import (
"log"
"os"

"github.com/slshen/sb/pkg/game"
"github.com/slshen/sb/pkg/playbyplay"
"github.com/slshen/paperscore/pkg/game"
"github.com/slshen/paperscore/pkg/playbyplay"
"github.com/spf13/cobra"
)

Expand Down
6 changes: 3 additions & 3 deletions cmd/re.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ import (
"fmt"
"os"

"github.com/slshen/sb/pkg/dataframe"
"github.com/slshen/sb/pkg/game"
"github.com/slshen/sb/pkg/stats"
"github.com/slshen/paperscore/pkg/dataframe"
"github.com/slshen/paperscore/pkg/game"
"github.com/slshen/paperscore/pkg/stats"
"github.com/spf13/cobra"
)

Expand Down
6 changes: 3 additions & 3 deletions cmd/re_args.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
package cmd

import (
"github.com/slshen/sb/pkg/config"
"github.com/slshen/sb/pkg/game"
"github.com/slshen/sb/pkg/stats"
"github.com/slshen/paperscore/pkg/config"
"github.com/slshen/paperscore/pkg/game"
"github.com/slshen/paperscore/pkg/stats"
"github.com/spf13/pflag"
)

Expand Down
2 changes: 1 addition & 1 deletion cmd/read.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ package cmd
import (
"fmt"

"github.com/slshen/sb/pkg/game"
"github.com/slshen/paperscore/pkg/game"
"github.com/spf13/cobra"
"gopkg.in/yaml.v3"
)
Expand Down
4 changes: 2 additions & 2 deletions cmd/sim.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ package cmd
import (
"fmt"

"github.com/slshen/sb/pkg/markov"
"github.com/slshen/sb/pkg/markov/expr"
"github.com/slshen/paperscore/pkg/markov"
"github.com/slshen/paperscore/pkg/markov/expr"
"github.com/spf13/cobra"
)

Expand Down
6 changes: 3 additions & 3 deletions cmd/stats.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ import (
"fmt"
"os"

"github.com/slshen/sb/pkg/dataframe"
"github.com/slshen/sb/pkg/game"
"github.com/slshen/sb/pkg/stats"
"github.com/slshen/paperscore/pkg/dataframe"
"github.com/slshen/paperscore/pkg/game"
"github.com/slshen/paperscore/pkg/stats"
"github.com/spf13/cobra"
)

Expand Down
6 changes: 3 additions & 3 deletions cmd/tournament.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ import (
"fmt"
"strings"

"github.com/slshen/sb/pkg/dataframe"
"github.com/slshen/sb/pkg/game"
"github.com/slshen/sb/pkg/tournament"
"github.com/slshen/paperscore/pkg/dataframe"
"github.com/slshen/paperscore/pkg/game"
"github.com/slshen/paperscore/pkg/tournament"
"github.com/spf13/cobra"
)

Expand Down
2 changes: 1 addition & 1 deletion cmd/ui.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import (
"log"
"os"

"github.com/slshen/sb/pkg/ui"
"github.com/slshen/paperscore/pkg/ui"
"github.com/spf13/cobra"
)

Expand Down
Binary file added doc/score.jpeg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
module github.com/slshen/sb
module github.com/slshen/paperscore

go 1.22.0

Expand Down
2 changes: 1 addition & 1 deletion main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ package main
import (
"os"

"github.com/slshen/sb/cmd"
"github.com/slshen/paperscore/cmd"
)

func main() {
Expand Down
10 changes: 5 additions & 5 deletions pkg/boxscore/box.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ import (
"strings"
"text/template"

"github.com/slshen/sb/pkg/dataframe"
"github.com/slshen/sb/pkg/game"
"github.com/slshen/sb/pkg/playbyplay"
"github.com/slshen/sb/pkg/stats"
"github.com/slshen/sb/pkg/text"
"github.com/slshen/paperscore/pkg/dataframe"
"github.com/slshen/paperscore/pkg/game"
"github.com/slshen/paperscore/pkg/playbyplay"
"github.com/slshen/paperscore/pkg/stats"
"github.com/slshen/paperscore/pkg/text"
)

//go:embed "*.tmpl"
Expand Down
2 changes: 1 addition & 1 deletion pkg/boxscore/box_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import (
"path/filepath"
"testing"

"github.com/slshen/sb/pkg/game"
"github.com/slshen/paperscore/pkg/game"
"github.com/stretchr/testify/assert"
)

Expand Down
6 changes: 3 additions & 3 deletions pkg/boxscore/lineup.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ import (
"fmt"
"strings"

"github.com/slshen/sb/pkg/dataframe"
"github.com/slshen/sb/pkg/stats"
"github.com/slshen/sb/pkg/text"
"github.com/slshen/paperscore/pkg/dataframe"
"github.com/slshen/paperscore/pkg/stats"
"github.com/slshen/paperscore/pkg/text"
)

type Lineup struct {
Expand Down
2 changes: 1 addition & 1 deletion pkg/boxscore/util.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import (
"strings"
"text/template"

"github.com/slshen/sb/pkg/text"
"github.com/slshen/paperscore/pkg/text"
)

func firstWord(s string, w int) string {
Expand Down
10 changes: 5 additions & 5 deletions pkg/dataexport/dataexport.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ import (
"sort"
"time"

"github.com/slshen/sb/pkg/dataframe"
"github.com/slshen/sb/pkg/dataframe/pkg"
"github.com/slshen/sb/pkg/game"
"github.com/slshen/sb/pkg/stats"
"github.com/slshen/sb/pkg/tournament"
"github.com/slshen/paperscore/pkg/dataframe"
"github.com/slshen/paperscore/pkg/dataframe/pkg"
"github.com/slshen/paperscore/pkg/game"
"github.com/slshen/paperscore/pkg/stats"
"github.com/slshen/paperscore/pkg/tournament"
)

type DataExport struct {
Expand Down
6 changes: 3 additions & 3 deletions pkg/dataexport/event.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ import (
"strings"

"github.com/mitchellh/mapstructure"
"github.com/slshen/sb/pkg/dataframe"
"github.com/slshen/sb/pkg/game"
"github.com/slshen/sb/pkg/stats"
"github.com/slshen/paperscore/pkg/dataframe"
"github.com/slshen/paperscore/pkg/game"
"github.com/slshen/paperscore/pkg/stats"
)

type Event struct {
Expand Down
2 changes: 1 addition & 1 deletion pkg/dataexport/event_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ package dataexport
import (
"testing"

"github.com/slshen/sb/pkg/game"
"github.com/slshen/paperscore/pkg/game"
"github.com/stretchr/testify/assert"
)

Expand Down
6 changes: 3 additions & 3 deletions pkg/dataexport/game.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ import (
"fmt"
"path/filepath"

"github.com/slshen/sb/pkg/boxscore"
"github.com/slshen/sb/pkg/dataframe"
"github.com/slshen/sb/pkg/game"
"github.com/slshen/paperscore/pkg/boxscore"
"github.com/slshen/paperscore/pkg/dataframe"
"github.com/slshen/paperscore/pkg/game"
)

type Game struct {
Expand Down
6 changes: 3 additions & 3 deletions pkg/dataexport/gamestats.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
package dataexport

import (
"github.com/slshen/sb/pkg/dataframe"
"github.com/slshen/sb/pkg/game"
"github.com/slshen/sb/pkg/stats"
"github.com/slshen/paperscore/pkg/dataframe"
"github.com/slshen/paperscore/pkg/game"
"github.com/slshen/paperscore/pkg/stats"
)

type GameStats struct {
Expand Down
2 changes: 1 addition & 1 deletion pkg/dataexport/tournament.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ package dataexport
import (
"time"

"github.com/slshen/sb/pkg/tournament"
"github.com/slshen/paperscore/pkg/tournament"
)

type Tournament struct {
Expand Down
2 changes: 1 addition & 1 deletion pkg/dataframe/data.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import (
"strings"

"github.com/mitchellh/mapstructure"
"github.com/slshen/sb/pkg/text"
"github.com/slshen/paperscore/pkg/text"
)

type Update interface {
Expand Down
2 changes: 1 addition & 1 deletion pkg/dataframe/pkg/datapackage.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import (
"os"
"path/filepath"

"github.com/slshen/sb/pkg/dataframe"
"github.com/slshen/paperscore/pkg/dataframe"
)

type License string
Expand Down
2 changes: 1 addition & 1 deletion pkg/game/advance.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ package game
import (
"regexp"

"github.com/slshen/sb/pkg/gamefile"
"github.com/slshen/paperscore/pkg/gamefile"
)

type Advance struct {
Expand Down
2 changes: 1 addition & 1 deletion pkg/game/advance_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ package game
import (
"testing"

"github.com/slshen/sb/pkg/gamefile"
"github.com/slshen/paperscore/pkg/gamefile"
"github.com/stretchr/testify/assert"
)

Expand Down
2 changes: 1 addition & 1 deletion pkg/game/error.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ package game
import (
"fmt"

"github.com/slshen/sb/pkg/gamefile"
"github.com/slshen/paperscore/pkg/gamefile"
)

type Error struct {
Expand Down
2 changes: 1 addition & 1 deletion pkg/game/fieldingerror.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import (
"fmt"
"strings"

"github.com/slshen/sb/pkg/gamefile"
"github.com/slshen/paperscore/pkg/gamefile"
)

type FieldingError struct {
Expand Down
Loading
Loading