Module Pre-processing/reorg

[Volte6]

Description

This reorganizes modules into their own packages/folders. Modules have been included in a single folder to allow them to be "automatically" compiled into the final binary thanks to a single include in main.go: _ "github.com/GoMudEngine/GoMud/modules"

However, the result is a cluttered folder containing all sorts of files or folders for various modules.

This change fixes 2 issues:

1. Cleans up clutter and organizational issues, making it easy to add/remove individual modules from your project, since they will be found within their own subfolder.
2. Forces module code to its own package namespace, no longer shared with other packages. This helps prevent namespace pollution and a tendency module-creators may have to directly reference code in other modules.

Concerns

• Modules will not be included in the build unless go generate is run before the build. This can be automated for those that use a make command, but for anyone on windows or unfamiliar with make, it needs to be explicitly called out to run go generate first.
  • To mitigate this somewhat, I've added a halt to the execution of the server if the go-generate hasn't been run yet:

~/dev/GoMud % go run .
!!! Run "go generate" before building this project !!!

Changes

• Moved all modules into their own subfolders
• Standardized module file embeds to files folder name within their own folder.
• Added cmd/generate/module-imports.go - this is only intended to be invoked via go generate, which handles the following compiler directive in main.go:
  • //go:generate go run cmd/generate/module-imports.go
  • This parses the modules folder off of the repo root and writes all folder names into the all-modules.go include, thereby forcing all modules to be included.
  • This allows the step to remain agnostic to operating system, instead of using specialized shell commands or scripts, a Go program does all of the work.

Example

Screenshot of output:

[lostsnow]

Comments are inaccurate

[Volte6]

Fixed.

~/dev/GoMud % make help

Build Targets                     
  build_rpi_zero2w: generate          - Build a binary for a raspberry pi zero 2w
  build_win64: generate               - Build a binary for 64bit windows
  build_linux64: generate             - Build a binary for linux
  build: validate build_local         - Validate the code and build the binary.
  ungenerate:                         - Reverts to a clean version of modules/all-modules.go
  generate:                           - Generates include directives for modules

Run Targets                       
  run:                                - Build and run server.
  client:                             - Build and run client terminal client

Help                              
  help:                               - List makefile targets.

[lostsnow]

LGTM