simon/lemonade
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

Initial commit

Browse source
This commit is contained in:
Simon Brooke 2017-09-11 20:35:22 +01:00
commit 62e46e6e7f
11 changed files with 642 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
CHANGELOG.md Normal file
View file

@ -0,0 +1,24 @@
# Change Log
All notable changes to this project will be documented in this file. This change log follows the conventions of [keepachangelog.com](http://keepachangelog.com/).
## [Unreleased]
### Changed
- Add a new arity to `make-widget-async` to provide a different widget shape.
## [0.1.1] - 2017-09-11
### Changed
- Documentation on how to make the widgets.
### Removed
- `make-widget-sync` - we're all async, all the time.
### Fixed
- Fixed widget maker to keep working when daylight savings switches over.
## 0.1.0 - 2017-09-11
### Added
- Files from the new template.
- Widget maker public API - `make-widget-sync`.
[Unreleased]: https://github.com/your-name/lemonade/compare/0.1.1...HEAD
[0.1.1]: https://github.com/your-name/lemonade/compare/0.1.0...0.1.1

85
LICENSE Normal file
View file

@ -0,0 +1,85 @@
GNU GENERAL PUBLIC LICENSE
Version 2, June 1991
Copyright (C) 1989, 1991 Free Software Foundation, Inc.
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This General Public License applies to most of the Free Software Foundation's software and to any other program whose authors commit to using it. (Some other Free Software Foundation software is covered by the GNU Lesser General Public License instead.) You can apply it to your programs, too.
When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things.
To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it.
For example, if you distribute copies of such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights.
We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software.
Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations.
Finally, any free program is threatened constantly by software patents. We wish to avoid the danger that redistributors of a free program will individually obtain patent licenses, in effect making the program proprietary. To prevent this, we have made it clear that any patent must be licensed for everyone's free use or not licensed at all.
The precise terms and conditions for copying, distribution and modification follow.
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The "Program", below, refers to any such program or work, and a "work based on the Program" means either the Program or any derivative work under copyright law: that is to say, a work containing the Program or a portion of it, either verbatim or with modifications and/or translated into another language. (Hereinafter, translation is included without limitation in the term "modification".) Each licensee is addressed as "you".
Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running the Program is not restricted, and the output from the Program is covered only if its contents constitute a work based on the Program (independent of having been made by running the Program). Whether that is true depends on what the Program does.
1. You may copy and distribute verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and give any other recipients of the Program a copy of this License along with the Program.
You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee.
2. You may modify your copy or copies of the Program or any portion of it, thus forming a work based on the Program, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions:
a) You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change.
b) You must cause any work that you distribute or publish, that in whole or in part contains or is derived from the Program or any part thereof, to be licensed as a whole at no charge to all third parties under the terms of this License.
c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the most ordinary way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this License. (Exception: if the Program itself is interactive but does not normally print such an announcement, your work based on the Program is not required to print an announcement.)
These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Program, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it.
Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Program.
In addition, mere aggregation of another work not based on the Program with the Program (or with a work based on the Program) on a volume of a storage or distribution medium does not bring the other work under the scope of this License.
3. You may copy and distribute the Program (or a work based on it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you also do one of the following:
a) Accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or,
b) Accompany it with a written offer, valid for at least three years, to give any third party, for a charge no more than your cost of physically performing source distribution, a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or,
c) Accompany it with the information you received as to the offer to distribute corresponding source code. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form with such an offer, in accord with Subsection b above.)
The source code for a work means the preferred form of the work for making modifications to it. For an executable work, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the executable. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable.
If distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distribution of the source code, even though third parties are not compelled to copy the source along with the object code.
4. You may not copy, modify, sublicense, or distribute the Program except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense or distribute the Program is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance.
5. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Program or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Program (or any work based on the Program), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Program or works based on it.
6. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties to this License.
7. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Program at all. For example, if a patent license would not permit royalty-free redistribution of the Program by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Program.
If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply and the section as a whole is intended to apply in other circumstances.
It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system, which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice.
This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License.
8. If the distribution and/or use of the Program is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Program under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License.
9. The Free Software Foundation may publish revised and/or new versions of the General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.
Each version is given a distinguishing version number. If the Program specifies a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of this License, you may choose any version ever published by the Free Software Foundation.
10. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally.
NO WARRANTY
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

35
README.md Normal file
View file

@ -0,0 +1,35 @@
# lemonade
A development environment and interpreter for text adventure games.
## Installation
No installation yet, this is very pre-alpha (and probably always will be).
## Usage
Doesn't work yet.
$ java -jar lemonade-0.1.0-standalone.jar [args]
## Options
FIXME: listing of options this app accepts.
## Examples
...
### Bugs
...
### Any Other Sections
### That You Think
### Might be Useful
## License
Copyright © 2017 Simon Brooke. Licensed under the GNU General Public License,
version 2.0 or (at your option) any later version. If you wish to incorporate
parts of Smeagol into another open source project which uses a less restrictive
license, please contact me; I'm open to dual licensing it.

191
envir.edn Normal file
View file

@ -0,0 +1,191 @@
{:objects
{:nailbrush
{:id :nailbrush,
:description "a dirty wooden nailbrush",
:objects nil,
:locked nil,
:container false,
:object true,
:type :object},
:cushion
{:id :cushion,
:description "a gingham cushion",
:objects nil,
:container false,
:object true,
:type :object},
:table
{:id :table,
:description "a wooden table",
:objects nil,
:container false,
:object true,
:type :object},
:soap
{:id :soap,
:description "a bar of coal-tar soap",
:objects nil,
:locked nil,
:container false,
:object true,
:type :object},
:toothbrush
{:id :toothbrush,
:description "a battered pink plastic toothbrush",
:objects nil,
:locked nil,
:container false,
:object true,
:type :object},
:oilskin
{:id :oilskin,
:description
"a greasy yellow oilskin coat, cracked across the shoulders",
:objects nil,
:container false,
:object true,
:type :object},
:kchair
{:id :kchair,
:description "a bentwood chair",
:objects nil,
:container false,
:object true,
:type :object},
:wheelbarrow
{:id :wheelbarrow,
:description "a broken wheelbarrow",
:objects nil,
:container false,
:object true,
:type :object},
:stove
{:id :stove,
:description "an ancient iron range",
:objects (),
:container true,
:object true,
:type :object},
:hatstand
{:id :hatstand,
:description "a hatstand",
:objects nil,
:container false,
:object true,
:type :object},
:fur-coat
{:id :fur-coat,
:description "a moth-eaten brown fur coat",
:objects nil,
:container false,
:object true,
:type :object},
:gaberdine
{:id :gaberdine,
:description "a dark gaberdine raincoat, which once was stylish",
:objects nil,
:container false,
:object true,
:type :object},
:macintosh
{:id :macintosh,
:description "the sort of raincoat your father used to wear",
:objects nil,
:container false,
:object true,
:type :object},
:clock
{:id :clock,
:description "a clock",
:objects nil,
:container false,
:object true,
:type :object},
:kchair2
{:id :kchair2,
:description "a bentwood chair with one arm",
:objects (:cushion),
:container true,
:object true,
:type :object},
:shears
{:id :shears,
:description
"a pair of rusty shears, which once might have trimmed the hedge",
:objects nil,
:container false,
:object true,
:type :object}},
:rooms
{:hall
{:description "a hall",
:west :closet,
:south :garden,
:objects (:clock :hatstand),
:type :room,
:east :kitchen,
:up :landing,
:id :hall,
:container true,
:room true,
:north :dining-room},
:kitchen
{:id :kitchen,
:objects (:table :stove :kchair :kchair2),
:description "a gloomy kitchen",
:container true,
:room true,
:type :room,
:west :hall},
:landing
{:description "a gloomy landing lit by a cobwebbed skylight",
:down :hall,
:objects (),
:type :room,
:east :bathroom,
:id :landing,
:container true,
:room true,
:north :bedroom},
:closet
{:id :closet,
:objects (:fur-coat :gaberdine :macintosh :oilskin),
:description "a dark closet mostly full of coats",
:container true,
:room true,
:type :room,
:east :hall},
:garden
{:description "An overgrown rose garden, which once was formal",
:south :road1,
:objects (),
:type :room,
:east :shed,
:id :garden,
:container true,
:room true,
:north :hall},
:shed
{:id :shed,
:objects (:wheelbarrow :shears),
:description "an old wooden shed",
:container true,
:room true,
:type :room,
:west :garden},
:road1
{:id :road1,
:objects (),
:description "a narrow road without pavements",
:container true,
:room true,
:type :room},
:bathroom
{:id :bathroom,
:objects (:toothbrush :nailbrush :soap),
:description
"a cramped and dirty bathroom with a bath, and an ancient toilet with a high iron cistern",
:container true,
:room true,
:type :room,
:west :landing}}}

9
project.clj Normal file
View file

@ -0,0 +1,9 @@
(defproject lemonade "0.1.0-SNAPSHOT"
:description "FIXME: write description"
:url "http://example.com/FIXME"
:license {:name "Eclipse Public License"
:url "http://www.eclipse.org/legal/epl-v10.html"}
:dependencies [[org.clojure/clojure "1.8.0"]]
:main ^:skip-aot lemonade.core
:target-path "target/%s"
:profiles {:uberjar {:aot :all}})

8
src/lemonade/ad_gen.clj Normal file
View file

@ -0,0 +1,8 @@
(ns lemonade.ad-gen
(:require [clojure.string :as s]
[lemonade.globals :refer :all]
[lemonade.utils :refer :all]))

7
src/lemonade/core.clj Normal file
View file

@ -0,0 +1,7 @@
(ns lemonade.core
(:gen-class))
(defn -main
"I don't do a whole lot ... yet."
[& args]
(println "Hello, World!"))

10
src/lemonade/globals.clj Normal file
View file

@ -0,0 +1,10 @@
(ns lemonade.globals)
(def all-dirs [:north :east :south :west :up :down])
(def empty-envir {:players {}
:rooms {}
:objects {}})
(def ^:dynamic *autosave* "autosave.edn")

132
src/lemonade/object.clj Normal file
View file

@ -0,0 +1,132 @@
(ns lemonade.object
(:require [clojure.pprint :refer [pprint]]
[clojure.string :as s]
[lemonade.globals :refer :all]
[lemonade.utils :refer :all]))
(defn find-container
"Find the id of the container that contains the object with this `id`,
if it exists in this `envir`. Return the id of the container, or nil
if not found."
([envir id]
(first
(remove
nil?
(mapcat
#(find-container envir id %)
(keys envir)))))
([envir id type-key]
(let [containers (type-key envir)]
(if
(map? containers)
(map
#(if
(some (fn [i] (= i id)) (:objects (% containers)))
%)
(keys containers))
'()))))
(defn find-type
"Find the id of the type of the item with this `id` in this `envir`, or
nil if not found."
([envir id]
(first
(remove
nil?
(map
#(find-type envir id %)
(keys envir)))))
([envir id type-key]
(if
(id (type-key envir))
type-key)))
(defn move-to
"Return an environment like this `envir`, but with the object with the id
obj-id removed from its current container and added to the container whose
id is `target-id`."
;; TODO not working yet. The object id gets removed from the source but not
;; delivered to the target.
[envir obj-id target-id]
(let [source-id (find-container envir obj-id)
source-type (find-type envir source-id)
source-container (source-id (source-type envir))
target-type (find-type envir target-id)
target-container (target-id (target-type envir))]
(println "source id: " source-id)
(println "source type: " source-type)
(pprint source-container)
(println "target id: " target-id)
(println "target-type: " target-type)
(pprint target-container)
(if
(and source-container (:container target-container))
(assoc
envir
target-type
(assoc
(target-type envir)
target-id
(assoc
target-container
:objects
(cons obj-id (:objects target-container))))
source-type
(assoc
(source-type envir)
source-id
(assoc
source-container
:objects
(remove #(= % obj-id) (:objects source-container)))))
(do
(println (str target-id " is not a container"))
envir))))
(defn add
"Create or add an object to an environment.
* `envir` should be an environment;
* `id` should be the keyword that will identify
the new object in the objects of the environment.
Returns a modified environment."
[envir id]
(cond
;; no need to recreate an object if it already exists in the environment
(and (keyword? id) (id (:objects envir))) envir
(keyword? id)
(do
(println (s/join " " ["Creating object" (name id)]))
(let
[description (prompt-for-string "Describe this object")
container (prompt-for-boolean "Is this object a container?")
objects (if container (prompt-for-tokens "What objects are in this container?"))
locked (if container (prompt-for-tokens "If this container is locked, what items can be used to open it?"))
object {:id id
:description description
;; an object can contain other objects only if it is a container
:objects objects
;; only containers can be locked. The value of locked is a list of all the
;; ids of objects that can open the container. Might later be optionally
;; a function which could be invoked to open the container.
:locked locked
:container container
:object true
:type :object}]
(pprint object)
(reduce
add
(assoc
envir
:objects
(assoc (:objects envir) id object))
(concat objects locked))))
true
(do
(println (str "'" id "' is not a valid object key"))
envir)))

76
src/lemonade/room.clj Normal file
View file

@ -0,0 +1,76 @@
(ns lemonade.room
(:require [clojure.pprint :refer [pprint]]
[clojure.string :as s]
[lemonade.globals :refer :all]
[lemonade.object :as object]
[lemonade.utils :refer :all]))
(defn get-neighbours
"Return a list of the ids of the neighbours of this `room` map,
or of the room identified by this `id` in this `envir`."
([room]
(remove nil? (map #(% room) all-dirs)))
([envir id]
(get-neighbours (id (:rooms envir)))))
(defn get-undescribed-rooms
"Return a list of the ids of rooms which are referenced in this
`envir`, but not present as rooms in it.
NOTE: if the envir was built using the environment builder, there
ought not to be any."
[envir]
(remove
(fn [id] ((:rooms envir) id))
(set
(mapcat
#(get-neighbours envir %)
(keys (:rooms envir))))))
(defn add
"Create or add a room to an environment.
* `envir` should be an environment;
* `id` should be the keyword that will identify
the new room in the rooms of the environment.
Returns a modified environment."
[envir id]
(perhaps-save envir)
(cond
;; no need to recreate a room if it already exists in the environment
(and (keyword? id) (id (:rooms envir))) envir
(keyword? id)
(do
(println (s/join " " ["Creating room" (name id)]))
(let
[description (prompt-for-string "Describe this room")
objects (prompt-for-tokens "What objects are in this room?")
room (reduce
#(let
[neighbour (prompt-for-token
(str "What room lies " %2 " of " id "?"))]
(if
neighbour (assoc %1 %2 neighbour)
%1))
{:id id
:objects objects
:description description
:container true
:room true
:type :room}
all-dirs)
with-room (assoc
(reduce object/add envir objects)
:rooms (assoc (:rooms envir) id room))]
(pprint with-room)
(reduce
add
with-room
(get-neighbours room))))
true
(do
(println (str "'" id "' is not a valid room key"))
envir)))

65
src/lemonade/utils.clj Normal file
View file

@ -0,0 +1,65 @@
(ns lemonade.utils
(:require [clojure.java.io :refer [writer]]
[clojure.pprint :refer [pprint]]
[clojure.string :as s]
[lemonade.globals :refer :all]))
(defn prompt-for-string
[& prompts]
(doall (map #(println %) prompts))
(print "> ")
(flush)
(read-line))
(defn prompt-for-tokens
[& prompts]
(let [p (if
(< (count prompts) 2)
(concat prompts ["(separate tokens with spaces or commas)"])
prompts)]
(remove
nil?
(map
#(if-not (zero? (count %))
(keyword %))
(s/split (s/replace (apply prompt-for-string p) ", " " ") #"\s")))))
(defn prompt-for-token
[& prompts]
(let [p (if
(< (count prompts) 2)
(concat prompts ["(separate tokens with spaces or commas)"])
prompts)]
(first (apply prompt-for-tokens p))))
(defn prompt-for-boolean
[& prompts]
(=
:y
(apply prompt-for-token (concat prompts ["y/n"]))))
(defn write-to-file [path object]
(with-open [scrivenor (writer path)]
(pprint object scrivenor)))
(defn perhaps-save
"If the global `*autosave*` is defined and is a string, treat it as a
file name to autosave to."
[envir]
(if
(string? *autosave*)
(try
(write-to-file *autosave* envir)
(println (str "Saved to " *autosave* "!"))
true
(catch Exception any
(println (str "Failed to save to " *autosave* " because " (.getMessage any)))
false))
false))