Add framework for ECS

.gitattributes

@@ -0,0 +1,2 @@
+*       text=auto
+*.hs    text eol=lf

CHANGELOG.md

@@ -0,0 +1,11 @@
+# Changelog for `pulsar`
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to the
+[Haskell Package Versioning Policy](https://pvp.haskell.org/).
+
+## Unreleased
+
+## 0.1.0.0 - YYYY-MM-DD

README.md

@@ -1,3 +1,13 @@
 # pulsar
 
 An ECS-driven Sci-Fi RPG to tool around in Haskell with
+
+## Setup for Development
+
+Stack is the canoncial build tool for this project. 
+
+Use `stack setup` to configure your environment.
+
+### Hlint
+You can use a system hlint, or use `stack build hlint` to build the same one we use.
+

Setup.hs

@@ -0,0 +1,2 @@
+import Distribution.Simple
+main = defaultMain

app/Main.hs

@@ -0,0 +1,7 @@
+module Main (main) where
+
+import Lib
+import Overseer
+
+main :: IO ()
+main = undefined

package.yaml

@@ -0,0 +1,66 @@
+name:                pulsar
+version:             0.1.0.0
+git:                 "Rin/pulsar"
+license:             "CC-BY-SA-4.0"
+author:              "Rin"
+maintainer:          "rin@rin.systems"
+copyright:           "2023 Rin"
+
+extra-source-files:
+- CHANGELOG.md
+
+# Metadata used when publishing your package
+# synopsis:            Short description of your package
+# category:            Web
+
+# To avoid duplicated efforts in documentation and dealing with the
+# complications of embedding Haddock markup inside cabal files, it is
+# common to point users to the README.md file.
+description:         Please see the README at <https://gitea.treehouse.systems/Rin/pulsar#readme>
+
+dependencies:
+  - base >= 4.7 && < 5
+  - ghc >= 9.4.7
+  - containers > 0.6.0.0 
+
+ghc-options:
+  - -Wall
+  - -Wcompat
+  - -Widentities
+  - -Wincomplete-record-updates
+  - -Wincomplete-record-selectors #  Coming Soon TM
+  - -Wincomplete-uni-patterns
+  - -Wmissing-export-lists
+  - -Wmissing-home-modules
+  - -Wpartial-fields
+  - -Wredundant-constraints
+
+default-extensions:
+  - DerivingVia
+  - LambdaCase
+  - NamedWildCards
+  - LexicalNegation
+  - NoStarIsType
+  - FunctionalDependencies
+  - GADTs
+  - DuplicateRecordFields
+  - RecordWildCards
+
+language: GHC2021
+
+library:
+  source-dirs: src
+
+executables:
+  pulsar-exe:
+    main:                Main.hs
+    source-dirs:         app
+    dependencies:
+    - pulsar
+
+tests:
+  pulsar-test:
+    main:                Spec.hs
+    source-dirs:         test
+    dependencies:
+    - pulsar

pulsar.cabal

@@ -0,0 +1,101 @@
+cabal-version: 2.2
+
+-- This file has been generated from package.yaml by hpack version 0.35.2.
+--
+-- see: https://github.com/sol/hpack
+
+name:           pulsar
+version:        0.1.0.0
+description:    Please see the README at <https://gitea.treehouse.systems/Rin/pulsar#readme>
+author:         Rin
+maintainer:     rin@rin.systems
+copyright:      2023 Rin
+license:        CC-BY-SA-4.0
+license-file:   LICENSE
+build-type:     Simple
+extra-source-files:
+    CHANGELOG.md
+
+source-repository head
+  type: git
+  location: Rin/pulsar
+
+library
+  exposed-modules:
+      Lib
+      Overseer
+  other-modules:
+      Paths_pulsar
+  autogen-modules:
+      Paths_pulsar
+  hs-source-dirs:
+      src
+  default-extensions:
+      DerivingVia
+      LambdaCase
+      NamedWildCards
+      LexicalNegation
+      NoStarIsType
+      FunctionalDependencies
+      GADTs
+      DuplicateRecordFields
+      RecordWildCards
+  ghc-options: -Wall -Wcompat -Widentities -Wincomplete-record-updates -Wincomplete-record-selectors -Wincomplete-uni-patterns -Wmissing-export-lists -Wmissing-home-modules -Wpartial-fields -Wredundant-constraints
+  build-depends:
+      base >=4.7 && <5
+    , containers >0.6.0.0
+    , ghc >=9.4.7
+  default-language: GHC2021
+
+executable pulsar-exe
+  main-is: Main.hs
+  other-modules:
+      Paths_pulsar
+  autogen-modules:
+      Paths_pulsar
+  hs-source-dirs:
+      app
+  default-extensions:
+      DerivingVia
+      LambdaCase
+      NamedWildCards
+      LexicalNegation
+      NoStarIsType
+      FunctionalDependencies
+      GADTs
+      DuplicateRecordFields
+      RecordWildCards
+  ghc-options: -Wall -Wcompat -Widentities -Wincomplete-record-updates -Wincomplete-record-selectors -Wincomplete-uni-patterns -Wmissing-export-lists -Wmissing-home-modules -Wpartial-fields -Wredundant-constraints
+  build-depends:
+      base >=4.7 && <5
+    , containers >0.6.0.0
+    , ghc >=9.4.7
+    , pulsar
+  default-language: GHC2021
+
+test-suite pulsar-test
+  type: exitcode-stdio-1.0
+  main-is: Spec.hs
+  other-modules:
+      Paths_pulsar
+  autogen-modules:
+      Paths_pulsar
+  hs-source-dirs:
+      test
+  default-extensions:
+      DerivingVia
+      LambdaCase
+      NamedWildCards
+      LexicalNegation
+      NoStarIsType
+      FunctionalDependencies
+      GADTs
+      DuplicateRecordFields
+      RecordWildCards
+  ghc-options: -Wall -Wcompat -Widentities -Wincomplete-record-updates -Wincomplete-record-selectors -Wincomplete-uni-patterns -Wmissing-export-lists -Wmissing-home-modules -Wpartial-fields -Wredundant-constraints
+  build-depends:
+      base >=4.7 && <5
+    , containers >0.6.0.0
+    , ghc >=9.4.7
+    , pulsar
+  default-language: GHC2021

src/Lib.hs

@@ -0,0 +1,58 @@
+module Lib(
+
+) where
+
+-- data Status = Success | Partial | Failure deriving (Eq, Ord, Show, Read)
+
+-- data Response i = ResponseMk {
+--   inform :: i,
+--   msg :: String,
+--   responseCode :: Status
+-- }
+
+import Data.Kind(Type)
+
+data Has :: (k -> Type) -> Type where
+  This :: p x -> Has p
+
+{-# DEPRECATED UID "Use the specialised UID newtypes instead" #-}
+type UID = Int
+
+class (Show a, Read a, Eq a, Ord a, Enum a) => IsUID a where
+  mkUID :: Int -> a
+  unUID :: a -> Int
+
+instance IsUID ItemUID where
+  mkUID = ItemUID
+  unUID (ItemUID a) = a
+instance IsUID BodyPartUID where
+  mkUID = BodyPartUID
+  unUID (BodyPartUID a) = a
+instance IsUID CreatureUID where
+  mkUID = CreatureUID
+  unUID (CreatureUID a) = a
+instance IsUID StructureUID where
+  mkUID = StructureUID
+  unUID (StructureUID a) = a
+instance IsUID CellUID where
+  mkUID = CellUID
+  unUID (CellUID a) = a
+instance IsUID EventUID where
+  mkUID = EventUID
+  unUID (EventUID a) = a
+instance IsUID TypeUID where
+  mkUID = TypeUID
+  unUID (TypeUID a) = a
+
+instance IsUID OverseerUID where
+  mkUID = OverseerUID
+  unUID (OverseerUID a) = a
+
+newtype ItemUID = ItemUID UID deriving (Show,Read,Eq,Ord,Enum) via Int
+newtype BodyPartUID = BodyPartUID UID deriving (Show,Read,Eq,Ord,Enum) via Int
+newtype CreatureUID = CreatureUID UID deriving (Show,Read,Eq,Ord,Enum) via Int
+newtype StructureUID = StructureUID UID deriving (Show,Read,Eq,Ord,Enum) via Int
+newtype CellUID = CellUID UID deriving (Show,Read,Eq,Ord,Enum) via Int
+newtype EventUID = EventUID UID deriving (Show,Read,Eq,Ord,Enum) via Int
+newtype TypeUID = TypeUID UID deriving (Show,Read,Eq,Ord,Enum) via Int
+newtype OverseerUID = OverseerUID UID deriving (Show, Read, Eq, Ord, Enum) via Int

src/Overseer.hs

@@ -0,0 +1,18 @@
+--{-# LANGUAGE TypeFamilyDependencies #-}
+module Overseer(
+  
+) where
+
+import Lib
+import Data.Sequence
+
+{-| The Overseer module handles disseminating and redirecting events between the relavent parties. Overall, this means that the Overseer for a type will have the full list of all UIDs in that type. For types with sub-types (such as the Creature -> BodyPart -> Sense relation), the Overseer carries the highest parent type.
+-- An efficient data structure for searching is required, as there will be many searches per tick. A BST is ideal, however this requires restructuring the UID type to be indicative of position (i.e. it should not be monotonically increasing unless the tree is self-balancing)
+-- Signalling success/failure back is important. Obviously, a bunch of events can be queued, however, there are race conditions. E.g. if two creatures attempt to pick up the same item in the same tick. In this case, we should use some deterministic mechanism to solve who gets priority. The other creature should be informed that they failed.
+-- In this system, a list of Actions will be compiled at each tick, and the GameState will fold over them for each Overseer, applying each to its relevant member.
+|-}
+
+---- GameState and Action Definitions -----------------------------------------------------------------------------------------------------
+
+-- TODO: Figure out how to structure actions and event queues
+--       This will likely require some kind of type-level list

stack.yaml

@@ -0,0 +1,68 @@
+# This file was automatically generated by 'stack init'
+#
+# Some commonly used options have been documented as comments in this file.
+# For advanced use and comprehensive documentation of the format, please see:
+# https://docs.haskellstack.org/en/stable/yaml_configuration/
+
+# Resolver to choose a 'specific' stackage snapshot or a compiler version.
+# A snapshot resolver dictates the compiler version and the set of packages
+# to be used for project dependencies. For example:
+#
+# resolver: lts-21.13
+# resolver: nightly-2023-09-24
+# resolver: ghc-9.6.2
+#
+# The location of a snapshot can be provided as a file or url. Stack assumes
+# a snapshot provided as a file might change, whereas a url resource does not.
+#
+# resolver: ./custom-snapshot.yaml
+# resolver: https://example.com/snapshots/2023-01-01.yaml
+resolver:
+  url: https://raw.githubusercontent.com/commercialhaskell/stackage-snapshots/master/lts/21/19.yaml
+
+# User packages to be built.
+# Various formats can be used as shown in the example below.
+#
+# packages:
+# - some-directory
+# - https://example.com/foo/bar/baz-0.0.2.tar.gz
+#   subdirs:
+#   - auto-update
+#   - wai
+packages:
+- .
+# Dependency packages to be pulled from upstream that are not in the resolver.
+# These entries can reference officially published versions as well as
+# forks / in-progress versions pinned to a git hash. For example:
+#
+# extra-deps:
+# - acme-missiles-0.3
+# - git: https://github.com/commercialhaskell/stack.git
+#   commit: e7b331f14bcffb8367cd58fbfc8b40ec7642100a
+#
+extra-deps:
+  - containers-0.6.7
+
+# Override default flag values for local packages and extra-deps
+# flags: {}
+
+# Extra package databases containing global packages
+# extra-package-dbs: []
+
+# Control whether we use the GHC we find on the path
+# system-ghc: true
+#
+# Require a specific version of Stack, using version ranges
+# require-stack-version: -any # Default
+# require-stack-version: ">=2.13"
+#
+# Override the architecture used by Stack, especially useful on Windows
+# arch: i386
+# arch: x86_64
+#
+# Extra directories used by Stack for building
+# extra-include-dirs: [/path/to/dir]
+# extra-lib-dirs: [/path/to/dir]
+#
+# Allow a newer minor version of GHC than the snapshot specifies
+compiler-check: newer-minor

stack.yaml.lock

@@ -0,0 +1,20 @@
+# This file was autogenerated by Stack.
+# You should not edit this file by hand.
+# For more information, please see the documentation at:
+#   https://docs.haskellstack.org/en/stable/lock_files
+
+packages:
+- completed:
+    hackage: containers-0.6.7@sha256:4aad61c33b21e453e5d18a465e674898fded282f233ffd154b48acc540c89537,2655
+    pantry-tree:
+      sha256: d3430bcc4beafe609d6c5cd4a607549ee4ffe0eafc2ebb9c87b5e7b1b20b24d8
+      size: 2902
+  original:
+    hackage: containers-0.6.7
+snapshots:
+- completed:
+    sha256: fb482b8e2d5d061cdda4ba1da2957c012740c893a5ee1c1b99001adae7b1fbe7
+    size: 640046
+    url: https://raw.githubusercontent.com/commercialhaskell/stackage-snapshots/master/lts/21/19.yaml
+  original:
+    url: https://raw.githubusercontent.com/commercialhaskell/stackage-snapshots/master/lts/21/19.yaml

test/Spec.hs

@@ -0,0 +1,2 @@
+main :: IO ()
+main = putStrLn "Test suite not yet implemented"