Compare commits
2 Commits
d4947a4434
...
5f294cceb2
| Author | SHA1 | Date | |
|---|---|---|---|
 deadvey
|
5f294cceb2 | ||
|
deadvey
|
051bfe46e4 |
+329
-328
@@ -70,152 +70,153 @@ modification follow.
|
|||||||
|
|
||||||
TERMS AND CONDITIONS
|
TERMS AND CONDITIONS
|
||||||
|
|
||||||
0. Definitions.
|
0. Definitions.
|
||||||
|
|
||||||
"This License" refers to version 3 of the GNU General Public License.
|
"This License" refers to version 3 of the GNU General Public License.
|
||||||
|
|
||||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||||
works, such as semiconductor masks.
|
works, such as semiconductor masks.
|
||||||
|
|
||||||
"The Program" refers to any copyrightable work licensed under this
|
"The Program" refers to any copyrightable work licensed under this
|
||||||
License. Each licensee is addressed as "you". "Licensees" and
|
License. Each licensee is addressed as "you". "Licensees" and
|
||||||
"recipients" may be individuals or organizations.
|
"recipients" may be individuals or organizations.
|
||||||
|
|
||||||
To "modify" a work means to copy from or adapt all or part of the work
|
To "modify" a work means to copy from or adapt all or part of the work
|
||||||
in a fashion requiring copyright permission, other than the making of an
|
in a fashion requiring copyright permission, other than the making of an
|
||||||
exact copy. The resulting work is called a "modified version" of the
|
exact copy. The resulting work is called a "modified version" of the
|
||||||
earlier work or a work "based on" the earlier work.
|
earlier work or a work "based on" the earlier work.
|
||||||
|
|
||||||
A "covered work" means either the unmodified Program or a work based
|
A "covered work" means either the unmodified Program or a work based
|
||||||
on the Program.
|
on the Program.
|
||||||
|
|
||||||
To "propagate" a work means to do anything with it that, without
|
To "propagate" a work means to do anything with it that, without
|
||||||
permission, would make you directly or secondarily liable for
|
permission, would make you directly or secondarily liable for
|
||||||
infringement under applicable copyright law, except executing it on a
|
infringement under applicable copyright law, except executing it on a
|
||||||
computer or modifying a private copy. Propagation includes copying,
|
computer or modifying a private copy. Propagation includes copying,
|
||||||
distribution (with or without modification), making available to the
|
distribution (with or without modification), making available to the
|
||||||
public, and in some countries other activities as well.
|
public, and in some countries other activities as well.
|
||||||
|
|
||||||
To "convey" a work means any kind of propagation that enables other
|
To "convey" a work means any kind of propagation that enables other
|
||||||
parties to make or receive copies. Mere interaction with a user through
|
parties to make or receive copies. Mere interaction with a user through
|
||||||
a computer network, with no transfer of a copy, is not conveying.
|
a computer network, with no transfer of a copy, is not conveying.
|
||||||
|
|
||||||
An interactive user interface displays "Appropriate Legal Notices"
|
An interactive user interface displays "Appropriate Legal Notices"
|
||||||
to the extent that it includes a convenient and prominently visible
|
to the extent that it includes a convenient and prominently visible
|
||||||
feature that (1) displays an appropriate copyright notice, and (2)
|
feature that (1) displays an appropriate copyright notice, and (2)
|
||||||
tells the user that there is no warranty for the work (except to the
|
tells the user that there is no warranty for the work (except to the
|
||||||
extent that warranties are provided), that licensees may convey the
|
extent that warranties are provided), that licensees may convey the
|
||||||
work under this License, and how to view a copy of this License. If
|
work under this License, and how to view a copy of this License. If
|
||||||
the interface presents a list of user commands or options, such as a
|
the interface presents a list of user commands or options, such as a
|
||||||
menu, a prominent item in the list meets this criterion.
|
menu, a prominent item in the list meets this criterion.
|
||||||
|
|
||||||
1. Source Code.
|
1. Source Code.
|
||||||
|
|
||||||
The "source code" for a work means the preferred form of the work
|
The "source code" for a work means the preferred form of the work
|
||||||
for making modifications to it. "Object code" means any non-source
|
for making modifications to it. "Object code" means any non-source
|
||||||
form of a work.
|
form of a work.
|
||||||
|
|
||||||
A "Standard Interface" means an interface that either is an official
|
A "Standard Interface" means an interface that either is an official
|
||||||
standard defined by a recognized standards body, or, in the case of
|
standard defined by a recognized standards body, or, in the case of
|
||||||
interfaces specified for a particular programming language, one that
|
interfaces specified for a particular programming language, one that
|
||||||
is widely used among developers working in that language.
|
is widely used among developers working in that language.
|
||||||
|
|
||||||
The "System Libraries" of an executable work include anything, other
|
The "System Libraries" of an executable work include anything, other
|
||||||
than the work as a whole, that (a) is included in the normal form of
|
than the work as a whole, that (a) is included in the normal form of
|
||||||
packaging a Major Component, but which is not part of that Major
|
packaging a Major Component, but which is not part of that Major
|
||||||
Component, and (b) serves only to enable use of the work with that
|
Component, and (b) serves only to enable use of the work with that
|
||||||
Major Component, or to implement a Standard Interface for which an
|
Major Component, or to implement a Standard Interface for which an
|
||||||
implementation is available to the public in source code form. A
|
implementation is available to the public in source code form. A
|
||||||
"Major Component", in this context, means a major essential component
|
"Major Component", in this context, means a major essential component
|
||||||
(kernel, window system, and so on) of the specific operating system
|
(kernel, window system, and so on) of the specific operating system
|
||||||
(if any) on which the executable work runs, or a compiler used to
|
(if any) on which the executable work runs, or a compiler used to
|
||||||
produce the work, or an object code interpreter used to run it.
|
produce the work, or an object code interpreter used to run it.
|
||||||
|
|
||||||
The "Corresponding Source" for a work in object code form means all
|
The "Corresponding Source" for a work in object code form means all
|
||||||
the source code needed to generate, install, and (for an executable
|
the source code needed to generate, install, and (for an executable
|
||||||
work) run the object code and to modify the work, including scripts to
|
work) run the object code and to modify the work, including scripts to
|
||||||
control those activities. However, it does not include the work's
|
control those activities. However, it does not include the work's
|
||||||
System Libraries, or general-purpose tools or generally available free
|
System Libraries, or general-purpose tools or generally available free
|
||||||
programs which are used unmodified in performing those activities but
|
programs which are used unmodified in performing those activities but
|
||||||
which are not part of the work. For example, Corresponding Source
|
which are not part of the work. For example, Corresponding Source
|
||||||
includes interface definition files associated with source files for
|
includes interface definition files associated with source files for
|
||||||
the work, and the source code for shared libraries and dynamically
|
the work, and the source code for shared libraries and dynamically
|
||||||
linked subprograms that the work is specifically designed to require,
|
linked subprograms that the work is specifically designed to require,
|
||||||
such as by intimate data communication or control flow between those
|
such as by intimate data communication or control flow between those
|
||||||
subprograms and other parts of the work.
|
subprograms and other parts of the work.
|
||||||
|
|
||||||
The Corresponding Source need not include anything that users
|
The Corresponding Source need not include anything that users
|
||||||
can regenerate automatically from other parts of the Corresponding
|
can regenerate automatically from other parts of the Corresponding
|
||||||
Source.
|
Source.
|
||||||
|
|
||||||
The Corresponding Source for a work in source code form is that
|
The Corresponding Source for a work in source code form is that
|
||||||
same work.
|
same work.
|
||||||
|
|
||||||
2. Basic Permissions.
|
2. Basic Permissions.
|
||||||
|
|
||||||
All rights granted under this License are granted for the term of
|
All rights granted under this License are granted for the term of
|
||||||
copyright on the Program, and are irrevocable provided the stated
|
copyright on the Program, and are irrevocable provided the stated
|
||||||
conditions are met. This License explicitly affirms your unlimited
|
conditions are met. This License explicitly affirms your unlimited
|
||||||
permission to run the unmodified Program. The output from running a
|
permission to run the unmodified Program. The output from running a
|
||||||
covered work is covered by this License only if the output, given its
|
covered work is covered by this License only if the output, given its
|
||||||
content, constitutes a covered work. This License acknowledges your
|
content, constitutes a covered work. This License acknowledges your
|
||||||
rights of fair use or other equivalent, as provided by copyright law.
|
rights of fair use or other equivalent, as provided by copyright law.
|
||||||
|
|
||||||
You may make, run and propagate covered works that you do not
|
You may make, run and propagate covered works that you do not
|
||||||
convey, without conditions so long as your license otherwise remains
|
convey, without conditions so long as your license otherwise remains
|
||||||
in force. You may convey covered works to others for the sole purpose
|
in force. You may convey covered works to others for the sole purpose
|
||||||
of having them make modifications exclusively for you, or provide you
|
of having them make modifications exclusively for you, or provide you
|
||||||
with facilities for running those works, provided that you comply with
|
with facilities for running those works, provided that you comply with
|
||||||
the terms of this License in conveying all material for which you do
|
the terms of this License in conveying all material for which you do
|
||||||
not control copyright. Those thus making or running the covered works
|
not control copyright. Those thus making or running the covered works
|
||||||
for you must do so exclusively on your behalf, under your direction
|
for you must do so exclusively on your behalf, under your direction
|
||||||
and control, on terms that prohibit them from making any copies of
|
and control, on terms that prohibit them from making any copies of
|
||||||
your copyrighted material outside their relationship with you.
|
your copyrighted material outside their relationship with you.
|
||||||
|
|
||||||
Conveying under any other circumstances is permitted solely under
|
Conveying under any other circumstances is permitted solely under
|
||||||
the conditions stated below. Sublicensing is not allowed; section 10
|
the conditions stated below. Sublicensing is not allowed; section 10
|
||||||
makes it unnecessary.
|
makes it unnecessary.
|
||||||
|
|
||||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||||
|
|
||||||
No covered work shall be deemed part of an effective technological
|
No covered work shall be deemed part of an effective technological
|
||||||
measure under any applicable law fulfilling obligations under article
|
measure under any applicable law fulfilling obligations under article
|
||||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||||
similar laws prohibiting or restricting circumvention of such
|
similar laws prohibiting or restricting circumvention of such
|
||||||
measures.
|
measures.
|
||||||
|
|
||||||
When you convey a covered work, you waive any legal power to forbid
|
When you convey a covered work, you waive any legal power to forbid
|
||||||
circumvention of technological measures to the extent such circumvention
|
circumvention of technological measures to the extent such circumvention
|
||||||
is effected by exercising rights under this License with respect to
|
is effected by exercising rights under this License with respect to
|
||||||
the covered work, and you disclaim any intention to limit operation or
|
the covered work, and you disclaim any intention to limit operation or
|
||||||
modification of the work as a means of enforcing, against the work's
|
modification of the work as a means of enforcing, against the work's
|
||||||
users, your or third parties' legal rights to forbid circumvention of
|
users, your or third parties' legal rights to forbid circumvention of
|
||||||
technological measures.
|
technological measures.
|
||||||
|
|
||||||
4. Conveying Verbatim Copies.
|
4. Conveying Verbatim Copies.
|
||||||
|
|
||||||
You may convey verbatim copies of the Program's source code as you
|
You may convey verbatim copies of the Program's source code as you
|
||||||
receive it, in any medium, provided that you conspicuously and
|
receive it, in any medium, provided that you conspicuously and
|
||||||
appropriately publish on each copy an appropriate copyright notice;
|
appropriately publish on each copy an appropriate copyright notice;
|
||||||
keep intact all notices stating that this License and any
|
keep intact all notices stating that this License and any
|
||||||
non-permissive terms added in accord with section 7 apply to the code;
|
non-permissive terms added in accord with section 7 apply to the code;
|
||||||
keep intact all notices of the absence of any warranty; and give all
|
keep intact all notices of the absence of any warranty; and give all
|
||||||
recipients a copy of this License along with the Program.
|
recipients a copy of this License along with the Program.
|
||||||
|
|
||||||
You may charge any price or no price for each copy that you convey,
|
You may charge any price or no price for each copy that you convey,
|
||||||
and you may offer support or warranty protection for a fee.
|
and you may offer support or warranty protection for a fee.
|
||||||
|
|
||||||
5. Conveying Modified Source Versions.
|
5. Conveying Modified Source Versions.
|
||||||
|
|
||||||
You may convey a work based on the Program, or the modifications to
|
You may convey a work based on the Program, or the modifications to
|
||||||
produce it from the Program, in the form of source code under the
|
produce it from the Program, in the form of source code under the
|
||||||
terms of section 4, provided that you also meet all of these conditions:
|
terms of section 4, provided that you also meet all of these conditions:
|
||||||
|
|
||||||
a) The work must carry prominent notices stating that you modified
|
a) The work must carry prominent notices stating that you modified
|
||||||
it, and giving a relevant date.
|
it, and giving a relevant date.
|
||||||
|
|
||||||
b) The work must carry prominent notices stating that it is
|
b) The work must carry prominent notices stating that it is
|
||||||
released under this License and any conditions added under section
|
released under this License and any conditions added under section
|
||||||
|
|
||||||
7. This requirement modifies the requirement in section 4 to
|
7. This requirement modifies the requirement in section 4 to
|
||||||
"keep intact all notices".
|
"keep intact all notices".
|
||||||
|
|
||||||
@@ -233,21 +234,21 @@ terms of section 4, provided that you also meet all of these conditions:
|
|||||||
work need not make them do so.
|
work need not make them do so.
|
||||||
|
|
||||||
A compilation of a covered work with other separate and independent
|
A compilation of a covered work with other separate and independent
|
||||||
works, which are not by their nature extensions of the covered work,
|
works, which are not by their nature extensions of the covered work,
|
||||||
and which are not combined with it such as to form a larger program,
|
and which are not combined with it such as to form a larger program,
|
||||||
in or on a volume of a storage or distribution medium, is called an
|
in or on a volume of a storage or distribution medium, is called an
|
||||||
"aggregate" if the compilation and its resulting copyright are not
|
"aggregate" if the compilation and its resulting copyright are not
|
||||||
used to limit the access or legal rights of the compilation's users
|
used to limit the access or legal rights of the compilation's users
|
||||||
beyond what the individual works permit. Inclusion of a covered work
|
beyond what the individual works permit. Inclusion of a covered work
|
||||||
in an aggregate does not cause this License to apply to the other
|
in an aggregate does not cause this License to apply to the other
|
||||||
parts of the aggregate.
|
parts of the aggregate.
|
||||||
|
|
||||||
6. Conveying Non-Source Forms.
|
6. Conveying Non-Source Forms.
|
||||||
|
|
||||||
You may convey a covered work in object code form under the terms
|
You may convey a covered work in object code form under the terms
|
||||||
of sections 4 and 5, provided that you also convey the
|
of sections 4 and 5, provided that you also convey the
|
||||||
machine-readable Corresponding Source under the terms of this License,
|
machine-readable Corresponding Source under the terms of this License,
|
||||||
in one of these ways:
|
in one of these ways:
|
||||||
|
|
||||||
a) Convey the object code in, or embodied in, a physical product
|
a) Convey the object code in, or embodied in, a physical product
|
||||||
(including a physical distribution medium), accompanied by the
|
(including a physical distribution medium), accompanied by the
|
||||||
@@ -291,76 +292,76 @@ in one of these ways:
|
|||||||
charge under subsection 6d.
|
charge under subsection 6d.
|
||||||
|
|
||||||
A separable portion of the object code, whose source code is excluded
|
A separable portion of the object code, whose source code is excluded
|
||||||
from the Corresponding Source as a System Library, need not be
|
from the Corresponding Source as a System Library, need not be
|
||||||
included in conveying the object code work.
|
included in conveying the object code work.
|
||||||
|
|
||||||
A "User Product" is either (1) a "consumer product", which means any
|
A "User Product" is either (1) a "consumer product", which means any
|
||||||
tangible personal property which is normally used for personal, family,
|
tangible personal property which is normally used for personal, family,
|
||||||
or household purposes, or (2) anything designed or sold for incorporation
|
or household purposes, or (2) anything designed or sold for incorporation
|
||||||
into a dwelling. In determining whether a product is a consumer product,
|
into a dwelling. In determining whether a product is a consumer product,
|
||||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||||
product received by a particular user, "normally used" refers to a
|
product received by a particular user, "normally used" refers to a
|
||||||
typical or common use of that class of product, regardless of the status
|
typical or common use of that class of product, regardless of the status
|
||||||
of the particular user or of the way in which the particular user
|
of the particular user or of the way in which the particular user
|
||||||
actually uses, or expects or is expected to use, the product. A product
|
actually uses, or expects or is expected to use, the product. A product
|
||||||
is a consumer product regardless of whether the product has substantial
|
is a consumer product regardless of whether the product has substantial
|
||||||
commercial, industrial or non-consumer uses, unless such uses represent
|
commercial, industrial or non-consumer uses, unless such uses represent
|
||||||
the only significant mode of use of the product.
|
the only significant mode of use of the product.
|
||||||
|
|
||||||
"Installation Information" for a User Product means any methods,
|
"Installation Information" for a User Product means any methods,
|
||||||
procedures, authorization keys, or other information required to install
|
procedures, authorization keys, or other information required to install
|
||||||
and execute modified versions of a covered work in that User Product from
|
and execute modified versions of a covered work in that User Product from
|
||||||
a modified version of its Corresponding Source. The information must
|
a modified version of its Corresponding Source. The information must
|
||||||
suffice to ensure that the continued functioning of the modified object
|
suffice to ensure that the continued functioning of the modified object
|
||||||
code is in no case prevented or interfered with solely because
|
code is in no case prevented or interfered with solely because
|
||||||
modification has been made.
|
modification has been made.
|
||||||
|
|
||||||
If you convey an object code work under this section in, or with, or
|
If you convey an object code work under this section in, or with, or
|
||||||
specifically for use in, a User Product, and the conveying occurs as
|
specifically for use in, a User Product, and the conveying occurs as
|
||||||
part of a transaction in which the right of possession and use of the
|
part of a transaction in which the right of possession and use of the
|
||||||
User Product is transferred to the recipient in perpetuity or for a
|
User Product is transferred to the recipient in perpetuity or for a
|
||||||
fixed term (regardless of how the transaction is characterized), the
|
fixed term (regardless of how the transaction is characterized), the
|
||||||
Corresponding Source conveyed under this section must be accompanied
|
Corresponding Source conveyed under this section must be accompanied
|
||||||
by the Installation Information. But this requirement does not apply
|
by the Installation Information. But this requirement does not apply
|
||||||
if neither you nor any third party retains the ability to install
|
if neither you nor any third party retains the ability to install
|
||||||
modified object code on the User Product (for example, the work has
|
modified object code on the User Product (for example, the work has
|
||||||
been installed in ROM).
|
been installed in ROM).
|
||||||
|
|
||||||
The requirement to provide Installation Information does not include a
|
The requirement to provide Installation Information does not include a
|
||||||
requirement to continue to provide support service, warranty, or updates
|
requirement to continue to provide support service, warranty, or updates
|
||||||
for a work that has been modified or installed by the recipient, or for
|
for a work that has been modified or installed by the recipient, or for
|
||||||
the User Product in which it has been modified or installed. Access to a
|
the User Product in which it has been modified or installed. Access to a
|
||||||
network may be denied when the modification itself materially and
|
network may be denied when the modification itself materially and
|
||||||
adversely affects the operation of the network or violates the rules and
|
adversely affects the operation of the network or violates the rules and
|
||||||
protocols for communication across the network.
|
protocols for communication across the network.
|
||||||
|
|
||||||
Corresponding Source conveyed, and Installation Information provided,
|
Corresponding Source conveyed, and Installation Information provided,
|
||||||
in accord with this section must be in a format that is publicly
|
in accord with this section must be in a format that is publicly
|
||||||
documented (and with an implementation available to the public in
|
documented (and with an implementation available to the public in
|
||||||
source code form), and must require no special password or key for
|
source code form), and must require no special password or key for
|
||||||
unpacking, reading or copying.
|
unpacking, reading or copying.
|
||||||
|
|
||||||
7. Additional Terms.
|
7. Additional Terms.
|
||||||
|
|
||||||
"Additional permissions" are terms that supplement the terms of this
|
"Additional permissions" are terms that supplement the terms of this
|
||||||
License by making exceptions from one or more of its conditions.
|
License by making exceptions from one or more of its conditions.
|
||||||
Additional permissions that are applicable to the entire Program shall
|
Additional permissions that are applicable to the entire Program shall
|
||||||
be treated as though they were included in this License, to the extent
|
be treated as though they were included in this License, to the extent
|
||||||
that they are valid under applicable law. If additional permissions
|
that they are valid under applicable law. If additional permissions
|
||||||
apply only to part of the Program, that part may be used separately
|
apply only to part of the Program, that part may be used separately
|
||||||
under those permissions, but the entire Program remains governed by
|
under those permissions, but the entire Program remains governed by
|
||||||
this License without regard to the additional permissions.
|
this License without regard to the additional permissions.
|
||||||
|
|
||||||
When you convey a copy of a covered work, you may at your option
|
When you convey a copy of a covered work, you may at your option
|
||||||
remove any additional permissions from that copy, or from any part of
|
remove any additional permissions from that copy, or from any part of
|
||||||
it. (Additional permissions may be written to require their own
|
it. (Additional permissions may be written to require their own
|
||||||
removal in certain cases when you modify the work.) You may place
|
removal in certain cases when you modify the work.) You may place
|
||||||
additional permissions on material, added by you to a covered work,
|
additional permissions on material, added by you to a covered work,
|
||||||
for which you have or can give appropriate copyright permission.
|
for which you have or can give appropriate copyright permission.
|
||||||
|
|
||||||
Notwithstanding any other provision of this License, for material you
|
Notwithstanding any other provision of this License, for material you
|
||||||
add to a covered work, you may (if authorized by the copyright holders of
|
add to a covered work, you may (if authorized by the copyright holders of
|
||||||
that material) supplement the terms of this License with terms:
|
that material) supplement the terms of this License with terms:
|
||||||
|
|
||||||
a) Disclaiming warranty or limiting liability differently from the
|
a) Disclaiming warranty or limiting liability differently from the
|
||||||
terms of sections 15 and 16 of this License; or
|
terms of sections 15 and 16 of this License; or
|
||||||
@@ -386,250 +387,250 @@ that material) supplement the terms of this License with terms:
|
|||||||
those licensors and authors.
|
those licensors and authors.
|
||||||
|
|
||||||
All other non-permissive additional terms are considered "further
|
All other non-permissive additional terms are considered "further
|
||||||
restrictions" within the meaning of section 10. If the Program as you
|
restrictions" within the meaning of section 10. If the Program as you
|
||||||
received it, or any part of it, contains a notice stating that it is
|
received it, or any part of it, contains a notice stating that it is
|
||||||
governed by this License along with a term that is a further
|
governed by this License along with a term that is a further
|
||||||
restriction, you may remove that term. If a license document contains
|
restriction, you may remove that term. If a license document contains
|
||||||
a further restriction but permits relicensing or conveying under this
|
a further restriction but permits relicensing or conveying under this
|
||||||
License, you may add to a covered work material governed by the terms
|
License, you may add to a covered work material governed by the terms
|
||||||
of that license document, provided that the further restriction does
|
of that license document, provided that the further restriction does
|
||||||
not survive such relicensing or conveying.
|
not survive such relicensing or conveying.
|
||||||
|
|
||||||
If you add terms to a covered work in accord with this section, you
|
If you add terms to a covered work in accord with this section, you
|
||||||
must place, in the relevant source files, a statement of the
|
must place, in the relevant source files, a statement of the
|
||||||
additional terms that apply to those files, or a notice indicating
|
additional terms that apply to those files, or a notice indicating
|
||||||
where to find the applicable terms.
|
where to find the applicable terms.
|
||||||
|
|
||||||
Additional terms, permissive or non-permissive, may be stated in the
|
Additional terms, permissive or non-permissive, may be stated in the
|
||||||
form of a separately written license, or stated as exceptions;
|
form of a separately written license, or stated as exceptions;
|
||||||
the above requirements apply either way.
|
the above requirements apply either way.
|
||||||
|
|
||||||
8. Termination.
|
8. Termination.
|
||||||
|
|
||||||
You may not propagate or modify a covered work except as expressly
|
You may not propagate or modify a covered work except as expressly
|
||||||
provided under this License. Any attempt otherwise to propagate or
|
provided under this License. Any attempt otherwise to propagate or
|
||||||
modify it is void, and will automatically terminate your rights under
|
modify it is void, and will automatically terminate your rights under
|
||||||
this License (including any patent licenses granted under the third
|
this License (including any patent licenses granted under the third
|
||||||
paragraph of section 11).
|
paragraph of section 11).
|
||||||
|
|
||||||
However, if you cease all violation of this License, then your
|
However, if you cease all violation of this License, then your
|
||||||
license from a particular copyright holder is reinstated (a)
|
license from a particular copyright holder is reinstated (a)
|
||||||
provisionally, unless and until the copyright holder explicitly and
|
provisionally, unless and until the copyright holder explicitly and
|
||||||
finally terminates your license, and (b) permanently, if the copyright
|
finally terminates your license, and (b) permanently, if the copyright
|
||||||
holder fails to notify you of the violation by some reasonable means
|
holder fails to notify you of the violation by some reasonable means
|
||||||
prior to 60 days after the cessation.
|
prior to 60 days after the cessation.
|
||||||
|
|
||||||
Moreover, your license from a particular copyright holder is
|
Moreover, your license from a particular copyright holder is
|
||||||
reinstated permanently if the copyright holder notifies you of the
|
reinstated permanently if the copyright holder notifies you of the
|
||||||
violation by some reasonable means, this is the first time you have
|
violation by some reasonable means, this is the first time you have
|
||||||
received notice of violation of this License (for any work) from that
|
received notice of violation of this License (for any work) from that
|
||||||
copyright holder, and you cure the violation prior to 30 days after
|
copyright holder, and you cure the violation prior to 30 days after
|
||||||
your receipt of the notice.
|
your receipt of the notice.
|
||||||
|
|
||||||
Termination of your rights under this section does not terminate the
|
Termination of your rights under this section does not terminate the
|
||||||
licenses of parties who have received copies or rights from you under
|
licenses of parties who have received copies or rights from you under
|
||||||
this License. If your rights have been terminated and not permanently
|
this License. If your rights have been terminated and not permanently
|
||||||
reinstated, you do not qualify to receive new licenses for the same
|
reinstated, you do not qualify to receive new licenses for the same
|
||||||
material under section 10.
|
material under section 10.
|
||||||
|
|
||||||
9. Acceptance Not Required for Having Copies.
|
9. Acceptance Not Required for Having Copies.
|
||||||
|
|
||||||
You are not required to accept this License in order to receive or
|
You are not required to accept this License in order to receive or
|
||||||
run a copy of the Program. Ancillary propagation of a covered work
|
run a copy of the Program. Ancillary propagation of a covered work
|
||||||
occurring solely as a consequence of using peer-to-peer transmission
|
occurring solely as a consequence of using peer-to-peer transmission
|
||||||
to receive a copy likewise does not require acceptance. However,
|
to receive a copy likewise does not require acceptance. However,
|
||||||
nothing other than this License grants you permission to propagate or
|
nothing other than this License grants you permission to propagate or
|
||||||
modify any covered work. These actions infringe copyright if you do
|
modify any covered work. These actions infringe copyright if you do
|
||||||
not accept this License. Therefore, by modifying or propagating a
|
not accept this License. Therefore, by modifying or propagating a
|
||||||
covered work, you indicate your acceptance of this License to do so.
|
covered work, you indicate your acceptance of this License to do so.
|
||||||
|
|
||||||
10. Automatic Licensing of Downstream Recipients.
|
10. Automatic Licensing of Downstream Recipients.
|
||||||
|
|
||||||
Each time you convey a covered work, the recipient automatically
|
Each time you convey a covered work, the recipient automatically
|
||||||
receives a license from the original licensors, to run, modify and
|
receives a license from the original licensors, to run, modify and
|
||||||
propagate that work, subject to this License. You are not responsible
|
propagate that work, subject to this License. You are not responsible
|
||||||
for enforcing compliance by third parties with this License.
|
for enforcing compliance by third parties with this License.
|
||||||
|
|
||||||
An "entity transaction" is a transaction transferring control of an
|
An "entity transaction" is a transaction transferring control of an
|
||||||
organization, or substantially all assets of one, or subdividing an
|
organization, or substantially all assets of one, or subdividing an
|
||||||
organization, or merging organizations. If propagation of a covered
|
organization, or merging organizations. If propagation of a covered
|
||||||
work results from an entity transaction, each party to that
|
work results from an entity transaction, each party to that
|
||||||
transaction who receives a copy of the work also receives whatever
|
transaction who receives a copy of the work also receives whatever
|
||||||
licenses to the work the party's predecessor in interest had or could
|
licenses to the work the party's predecessor in interest had or could
|
||||||
give under the previous paragraph, plus a right to possession of the
|
give under the previous paragraph, plus a right to possession of the
|
||||||
Corresponding Source of the work from the predecessor in interest, if
|
Corresponding Source of the work from the predecessor in interest, if
|
||||||
the predecessor has it or can get it with reasonable efforts.
|
the predecessor has it or can get it with reasonable efforts.
|
||||||
|
|
||||||
You may not impose any further restrictions on the exercise of the
|
You may not impose any further restrictions on the exercise of the
|
||||||
rights granted or affirmed under this License. For example, you may
|
rights granted or affirmed under this License. For example, you may
|
||||||
not impose a license fee, royalty, or other charge for exercise of
|
not impose a license fee, royalty, or other charge for exercise of
|
||||||
rights granted under this License, and you may not initiate litigation
|
rights granted under this License, and you may not initiate litigation
|
||||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||||
any patent claim is infringed by making, using, selling, offering for
|
any patent claim is infringed by making, using, selling, offering for
|
||||||
sale, or importing the Program or any portion of it.
|
sale, or importing the Program or any portion of it.
|
||||||
|
|
||||||
11. Patents.
|
11. Patents.
|
||||||
|
|
||||||
A "contributor" is a copyright holder who authorizes use under this
|
A "contributor" is a copyright holder who authorizes use under this
|
||||||
License of the Program or a work on which the Program is based. The
|
License of the Program or a work on which the Program is based. The
|
||||||
work thus licensed is called the contributor's "contributor version".
|
work thus licensed is called the contributor's "contributor version".
|
||||||
|
|
||||||
A contributor's "essential patent claims" are all patent claims
|
A contributor's "essential patent claims" are all patent claims
|
||||||
owned or controlled by the contributor, whether already acquired or
|
owned or controlled by the contributor, whether already acquired or
|
||||||
hereafter acquired, that would be infringed by some manner, permitted
|
hereafter acquired, that would be infringed by some manner, permitted
|
||||||
by this License, of making, using, or selling its contributor version,
|
by this License, of making, using, or selling its contributor version,
|
||||||
but do not include claims that would be infringed only as a
|
but do not include claims that would be infringed only as a
|
||||||
consequence of further modification of the contributor version. For
|
consequence of further modification of the contributor version. For
|
||||||
purposes of this definition, "control" includes the right to grant
|
purposes of this definition, "control" includes the right to grant
|
||||||
patent sublicenses in a manner consistent with the requirements of
|
patent sublicenses in a manner consistent with the requirements of
|
||||||
this License.
|
this License.
|
||||||
|
|
||||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||||
patent license under the contributor's essential patent claims, to
|
patent license under the contributor's essential patent claims, to
|
||||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||||
propagate the contents of its contributor version.
|
propagate the contents of its contributor version.
|
||||||
|
|
||||||
In the following three paragraphs, a "patent license" is any express
|
In the following three paragraphs, a "patent license" is any express
|
||||||
agreement or commitment, however denominated, not to enforce a patent
|
agreement or commitment, however denominated, not to enforce a patent
|
||||||
(such as an express permission to practice a patent or covenant not to
|
(such as an express permission to practice a patent or covenant not to
|
||||||
sue for patent infringement). To "grant" such a patent license to a
|
sue for patent infringement). To "grant" such a patent license to a
|
||||||
party means to make such an agreement or commitment not to enforce a
|
party means to make such an agreement or commitment not to enforce a
|
||||||
patent against the party.
|
patent against the party.
|
||||||
|
|
||||||
If you convey a covered work, knowingly relying on a patent license,
|
If you convey a covered work, knowingly relying on a patent license,
|
||||||
and the Corresponding Source of the work is not available for anyone
|
and the Corresponding Source of the work is not available for anyone
|
||||||
to copy, free of charge and under the terms of this License, through a
|
to copy, free of charge and under the terms of this License, through a
|
||||||
publicly available network server or other readily accessible means,
|
publicly available network server or other readily accessible means,
|
||||||
then you must either (1) cause the Corresponding Source to be so
|
then you must either (1) cause the Corresponding Source to be so
|
||||||
available, or (2) arrange to deprive yourself of the benefit of the
|
available, or (2) arrange to deprive yourself of the benefit of the
|
||||||
patent license for this particular work, or (3) arrange, in a manner
|
patent license for this particular work, or (3) arrange, in a manner
|
||||||
consistent with the requirements of this License, to extend the patent
|
consistent with the requirements of this License, to extend the patent
|
||||||
license to downstream recipients. "Knowingly relying" means you have
|
license to downstream recipients. "Knowingly relying" means you have
|
||||||
actual knowledge that, but for the patent license, your conveying the
|
actual knowledge that, but for the patent license, your conveying the
|
||||||
covered work in a country, or your recipient's use of the covered work
|
covered work in a country, or your recipient's use of the covered work
|
||||||
in a country, would infringe one or more identifiable patents in that
|
in a country, would infringe one or more identifiable patents in that
|
||||||
country that you have reason to believe are valid.
|
country that you have reason to believe are valid.
|
||||||
|
|
||||||
If, pursuant to or in connection with a single transaction or
|
If, pursuant to or in connection with a single transaction or
|
||||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||||
covered work, and grant a patent license to some of the parties
|
covered work, and grant a patent license to some of the parties
|
||||||
receiving the covered work authorizing them to use, propagate, modify
|
receiving the covered work authorizing them to use, propagate, modify
|
||||||
or convey a specific copy of the covered work, then the patent license
|
or convey a specific copy of the covered work, then the patent license
|
||||||
you grant is automatically extended to all recipients of the covered
|
you grant is automatically extended to all recipients of the covered
|
||||||
work and works based on it.
|
work and works based on it.
|
||||||
|
|
||||||
A patent license is "discriminatory" if it does not include within
|
A patent license is "discriminatory" if it does not include within
|
||||||
the scope of its coverage, prohibits the exercise of, or is
|
the scope of its coverage, prohibits the exercise of, or is
|
||||||
conditioned on the non-exercise of one or more of the rights that are
|
conditioned on the non-exercise of one or more of the rights that are
|
||||||
specifically granted under this License. You may not convey a covered
|
specifically granted under this License. You may not convey a covered
|
||||||
work if you are a party to an arrangement with a third party that is
|
work if you are a party to an arrangement with a third party that is
|
||||||
in the business of distributing software, under which you make payment
|
in the business of distributing software, under which you make payment
|
||||||
to the third party based on the extent of your activity of conveying
|
to the third party based on the extent of your activity of conveying
|
||||||
the work, and under which the third party grants, to any of the
|
the work, and under which the third party grants, to any of the
|
||||||
parties who would receive the covered work from you, a discriminatory
|
parties who would receive the covered work from you, a discriminatory
|
||||||
patent license (a) in connection with copies of the covered work
|
patent license (a) in connection with copies of the covered work
|
||||||
conveyed by you (or copies made from those copies), or (b) primarily
|
conveyed by you (or copies made from those copies), or (b) primarily
|
||||||
for and in connection with specific products or compilations that
|
for and in connection with specific products or compilations that
|
||||||
contain the covered work, unless you entered into that arrangement,
|
contain the covered work, unless you entered into that arrangement,
|
||||||
or that patent license was granted, prior to 28 March 2007.
|
or that patent license was granted, prior to 28 March 2007.
|
||||||
|
|
||||||
Nothing in this License shall be construed as excluding or limiting
|
Nothing in this License shall be construed as excluding or limiting
|
||||||
any implied license or other defenses to infringement that may
|
any implied license or other defenses to infringement that may
|
||||||
otherwise be available to you under applicable patent law.
|
otherwise be available to you under applicable patent law.
|
||||||
|
|
||||||
12. No Surrender of Others' Freedom.
|
12. No Surrender of Others' Freedom.
|
||||||
|
|
||||||
If conditions are imposed on you (whether by court order, agreement or
|
If conditions are imposed on you (whether by court order, agreement or
|
||||||
otherwise) that contradict the conditions of this License, they do not
|
otherwise) that contradict the conditions of this License, they do not
|
||||||
excuse you from the conditions of this License. If you cannot convey a
|
excuse you from the conditions of this License. If you cannot convey a
|
||||||
covered work so as to satisfy simultaneously your obligations under this
|
covered work so as to satisfy simultaneously your obligations under this
|
||||||
License and any other pertinent obligations, then as a consequence you may
|
License and any other pertinent obligations, then as a consequence you may
|
||||||
not convey it at all. For example, if you agree to terms that obligate you
|
not convey it at all. For example, if you agree to terms that obligate you
|
||||||
to collect a royalty for further conveying from those to whom you convey
|
to collect a royalty for further conveying from those to whom you convey
|
||||||
the Program, the only way you could satisfy both those terms and this
|
the Program, the only way you could satisfy both those terms and this
|
||||||
License would be to refrain entirely from conveying the Program.
|
License would be to refrain entirely from conveying the Program.
|
||||||
|
|
||||||
13. Use with the GNU Affero General Public License.
|
13. Use with the GNU Affero General Public License.
|
||||||
|
|
||||||
Notwithstanding any other provision of this License, you have
|
Notwithstanding any other provision of this License, you have
|
||||||
permission to link or combine any covered work with a work licensed
|
permission to link or combine any covered work with a work licensed
|
||||||
under version 3 of the GNU Affero General Public License into a single
|
under version 3 of the GNU Affero General Public License into a single
|
||||||
combined work, and to convey the resulting work. The terms of this
|
combined work, and to convey the resulting work. The terms of this
|
||||||
License will continue to apply to the part which is the covered work,
|
License will continue to apply to the part which is the covered work,
|
||||||
but the special requirements of the GNU Affero General Public License,
|
but the special requirements of the GNU Affero General Public License,
|
||||||
section 13, concerning interaction through a network will apply to the
|
section 13, concerning interaction through a network will apply to the
|
||||||
combination as such.
|
combination as such.
|
||||||
|
|
||||||
14. Revised Versions of this License.
|
14. Revised Versions of this License.
|
||||||
|
|
||||||
The Free Software Foundation may publish revised and/or new versions of
|
The Free Software Foundation may publish revised and/or new versions of
|
||||||
the GNU General Public License from time to time. Such new versions will
|
the GNU 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
|
be similar in spirit to the present version, but may differ in detail to
|
||||||
address new problems or concerns.
|
address new problems or concerns.
|
||||||
|
|
||||||
Each version is given a distinguishing version number. If the
|
Each version is given a distinguishing version number. If the
|
||||||
Program specifies that a certain numbered version of the GNU General
|
Program specifies that a certain numbered version of the GNU General
|
||||||
Public License "or any later version" applies to it, you have the
|
Public License "or any later version" applies to it, you have the
|
||||||
option of following the terms and conditions either of that numbered
|
option of following the terms and conditions either of that numbered
|
||||||
version or of any later version published by the Free Software
|
version or of any later version published by the Free Software
|
||||||
Foundation. If the Program does not specify a version number of the
|
Foundation. If the Program does not specify a version number of the
|
||||||
GNU General Public License, you may choose any version ever published
|
GNU General Public License, you may choose any version ever published
|
||||||
by the Free Software Foundation.
|
by the Free Software Foundation.
|
||||||
|
|
||||||
If the Program specifies that a proxy can decide which future
|
If the Program specifies that a proxy can decide which future
|
||||||
versions of the GNU General Public License can be used, that proxy's
|
versions of the GNU General Public License can be used, that proxy's
|
||||||
public statement of acceptance of a version permanently authorizes you
|
public statement of acceptance of a version permanently authorizes you
|
||||||
to choose that version for the Program.
|
to choose that version for the Program.
|
||||||
|
|
||||||
Later license versions may give you additional or different
|
Later license versions may give you additional or different
|
||||||
permissions. However, no additional obligations are imposed on any
|
permissions. However, no additional obligations are imposed on any
|
||||||
author or copyright holder as a result of your choosing to follow a
|
author or copyright holder as a result of your choosing to follow a
|
||||||
later version.
|
later version.
|
||||||
|
|
||||||
15. Disclaimer of Warranty.
|
15. Disclaimer of Warranty.
|
||||||
|
|
||||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
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
|
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||||
|
|
||||||
16. Limitation of Liability.
|
16. Limitation of Liability.
|
||||||
|
|
||||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
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
|
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),
|
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
|
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||||
SUCH DAMAGES.
|
SUCH DAMAGES.
|
||||||
|
|
||||||
17. Interpretation of Sections 15 and 16.
|
17. Interpretation of Sections 15 and 16.
|
||||||
|
|
||||||
If the disclaimer of warranty and limitation of liability provided
|
If the disclaimer of warranty and limitation of liability provided
|
||||||
above cannot be given local legal effect according to their terms,
|
above cannot be given local legal effect according to their terms,
|
||||||
reviewing courts shall apply local law that most closely approximates
|
reviewing courts shall apply local law that most closely approximates
|
||||||
an absolute waiver of all civil liability in connection with the
|
an absolute waiver of all civil liability in connection with the
|
||||||
Program, unless a warranty or assumption of liability accompanies a
|
Program, unless a warranty or assumption of liability accompanies a
|
||||||
copy of the Program in return for a fee.
|
copy of the Program in return for a fee.
|
||||||
|
|
||||||
END OF TERMS AND CONDITIONS
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
How to Apply These Terms to Your New Programs
|
How to Apply These Terms to Your New Programs
|
||||||
|
|
||||||
If you develop a new program, and you want it to be of the greatest
|
If you develop a new program, and you want it to be of the greatest
|
||||||
possible use to the public, the best way to achieve this is to make it
|
possible use to the public, the best way to achieve this is to make it
|
||||||
free software which everyone can redistribute and change under these terms.
|
free software which everyone can redistribute and change under these terms.
|
||||||
|
|
||||||
To do so, attach the following notices to the program. It is safest
|
To do so, attach the following notices to the program. It is safest
|
||||||
to attach them to the start of each source file to most effectively
|
to attach them to the start of each source file to most effectively
|
||||||
state the exclusion of warranty; and each file should have at least
|
state the exclusion of warranty; and each file should have at least
|
||||||
the "copyright" line and a pointer to where the full notice is found.
|
the "copyright" line and a pointer to where the full notice is found.
|
||||||
|
|
||||||
<one line to give the program's name and a brief idea of what it does.>
|
<one line to give the program's name and a brief idea of what it does.>
|
||||||
Copyright (C) <year> <name of author>
|
Copyright (C) <year> <name of author>
|
||||||
|
|||||||
@@ -2,6 +2,8 @@
|
|||||||
|
|
||||||
An interactive story telling software.
|
An interactive story telling software.
|
||||||
Read and write people's stories
|
Read and write people's stories
|
||||||
|
For help with making a story, see [this documentation](/docs/MAKING_A_STORY.md)
|
||||||
|
For help with syntax, see [this documentation](/docs/SYNTAX.md)
|
||||||
|
|
||||||
## Install
|
## Install
|
||||||
|
|
||||||
@@ -9,11 +11,7 @@ This is not really out of development, but to run it, clone the repo, go into /s
|
|||||||
|
|
||||||
## Technical Details
|
## Technical Details
|
||||||
|
|
||||||
### Back-end server -- Rust
|
### File layout
|
||||||
|
|
||||||
The server component of Happening will be written in Rust.<br/>
|
|
||||||
Parses the code and sends it via the API.<br/>
|
|
||||||
File layout:
|
|
||||||
|
|
||||||
- animations/
|
- animations/
|
||||||
- features/
|
- features/
|
||||||
@@ -30,13 +28,24 @@ File layout:
|
|||||||
- scenes/
|
- scenes/
|
||||||
- images/
|
- images/
|
||||||
|
|
||||||
The variables are stored as a hashmap, characters are objects.<br/>
|
### Back-end server -- Rust
|
||||||
|
|
||||||
|
The server component of Happening will be written in Rust.<br/>
|
||||||
|
Parses the code and sends it via the API.<br/>
|
||||||
|
File layout:
|
||||||
|
|
||||||
|
The variables are stored as a hashmap, characters are structs in a hashmap.<br/>
|
||||||
|
|
||||||
### API
|
### API
|
||||||
|
|
||||||
Using the network interface, port 20264.<br/>
|
Using the network interface, port 20264.<br/>
|
||||||
|
|
||||||
Characters are sent to the frontend and stored there when the character is created on the frontend.<br/>
|
Characters are sent to the frontend and stored there when the character is created on the frontend.<br/>
|
||||||
|
There are 4 endpoints.
|
||||||
|
|
||||||
|
#### /happening
|
||||||
|
|
||||||
|
GET Returns what is happening on the next cycle:
|
||||||
|
|
||||||
```
|
```
|
||||||
{
|
{
|
||||||
@@ -47,35 +56,41 @@ content: String,
|
|||||||
|
|
||||||
character: String,
|
character: String,
|
||||||
|
|
||||||
|
choice: [String,String,String,...]
|
||||||
|
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
#### /character/\<character name\>
|
||||||
|
GET Returns the struct of the character, ideally this should only be gotten when a new character is made or a character changes a feature.
|
||||||
|
|
||||||
|
#### /choice
|
||||||
|
POST the choice as a JSON formatting number, eg 1 to choose choice index 1, returns "ack" as acknowledgment.
|
||||||
|
|
||||||
|
#### /input
|
||||||
|
POST not yet fully implemented on the syntax side but allows client to send a user input to the server as text. returns "ack" as acknowlegment.
|
||||||
|
|
||||||
### Frontend -- Python
|
### Frontend -- Python
|
||||||
|
|
||||||
Things the frontend can do:
|
Things the frontend should be able to:
|
||||||
|
|
||||||
- Output text
|
- Output text
|
||||||
- Display the character
|
- Display the character
|
||||||
- Move characters around
|
- Move characters around
|
||||||
- Display a choice to the user that gets sent back to the server
|
- Display a choice to the user that gets sent back to the server
|
||||||
|
|
||||||
### Syntax
|
### Files
|
||||||
|
|
||||||
#### Setup
|
For more info on these files see [Making a Story](/docs/MAKING_A_STORY.md)
|
||||||
|
|
||||||
This is done in the about.json file,
|
#### story.ha
|
||||||
|
|
||||||
```
|
This contains the code for the story, syntax for writing the code can be seen in [the syntax section](/docs/SYNTAX.md)
|
||||||
{
|
|
||||||
|
|
||||||
"title": "My Great Story",
|
#### about.json
|
||||||
|
|
||||||
"description": "please read!"
|
This file contains details about your story such as the title and description.
|
||||||
|
|
||||||
}
|
#### characters.json
|
||||||
```
|
|
||||||
|
|
||||||
#### Characters
|
|
||||||
|
|
||||||
See [Character documentation](/docs/CHARACTER.md) for more info
|
See [Character documentation](/docs/CHARACTER.md) for more info
|
||||||
Referencing a character using the @, @NARRATOR is reserved for the Narrator.<br/>
|
Referencing a character using the @, @NARRATOR is reserved for the Narrator.<br/>
|
||||||
@@ -85,72 +100,6 @@ Move a character with @CHARACTER to fr
|
|||||||
> [!NOTE]
|
> [!NOTE]
|
||||||
> fr means front-right for instance.
|
> fr means front-right for instance.
|
||||||
|
|
||||||
#### Outputs
|
|
||||||
|
|
||||||
```
|
|
||||||
@CHARACTER says "this string
|
|
||||||
is multi-line
|
|
||||||
and ends with a"
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Variables
|
|
||||||
|
|
||||||
Variables are referenced with the \$, only integers will be supported.<br/>
|
|
||||||
|
|
||||||
#### Selection
|
|
||||||
|
|
||||||
Condition based:
|
|
||||||
|
|
||||||
```
|
|
||||||
if (condition) {
|
|
||||||
|
|
||||||
}
|
|
||||||
|
|
||||||
elif (condition) {
|
|
||||||
|
|
||||||
}
|
|
||||||
|
|
||||||
else
|
|
||||||
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
Choice based:
|
|
||||||
|
|
||||||
```
|
|
||||||
choice "choice 1" {
|
|
||||||
|
|
||||||
}
|
|
||||||
|
|
||||||
or "choice 2" {
|
|
||||||
|
|
||||||
}
|
|
||||||
|
|
||||||
or "choice 3" {
|
|
||||||
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Positioning
|
|
||||||
|
|
||||||
```
|
|
||||||
@CHARACTER to position
|
|
||||||
|
|
||||||
PAN to position
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Other
|
|
||||||
|
|
||||||
```
|
|
||||||
label:
|
|
||||||
|
|
||||||
GOTO label
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Ending
|
|
||||||
|
|
||||||
`END` to exit out of the story
|
|
||||||
|
|
||||||
## Implemented stuff
|
## Implemented stuff
|
||||||
|
|
||||||
### Commands
|
### Commands
|
||||||
@@ -160,7 +109,7 @@ GOTO label
|
|||||||
| END | Yes |
|
| END | Yes |
|
||||||
| CHOICE/OR/OR | Yes |
|
| CHOICE/OR/OR | Yes |
|
||||||
| IF/ELSE IF/ELSE | No |
|
| IF/ELSE IF/ELSE | No |
|
||||||
| GOTO | No |
|
| GOTO | Yes |
|
||||||
| PAN | No |
|
| PAN | No |
|
||||||
|
|
||||||
### Character sub-commands
|
### Character sub-commands
|
||||||
@@ -178,6 +127,7 @@ GOTO label
|
|||||||
| ---------- | ----------- |
|
| ---------- | ----------- |
|
||||||
| Variables | No |
|
| Variables | No |
|
||||||
| about.json | No |
|
| about.json | No |
|
||||||
|
| INPUT | Partially |
|
||||||
|
|
||||||
## Error codes
|
## Error codes
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,34 @@
|
|||||||
|
# Making a Story
|
||||||
|
|
||||||
|
## Setting up
|
||||||
|
|
||||||
|
You need these three files to make a story:
|
||||||
|
|
||||||
|
- about.json
|
||||||
|
|
||||||
|
- story.ha
|
||||||
|
|
||||||
|
- characters.json
|
||||||
|
|
||||||
|
## Filling out the files
|
||||||
|
|
||||||
|
Inside about.json should be the following content:
|
||||||
|
|
||||||
|
```
|
||||||
|
{
|
||||||
|
"title": "My Great Story",
|
||||||
|
"description": "please read!"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Change the title and description to whatever you would like.<br/>
|
||||||
|
Inside story.ha should be the code for your story, see [the documentation on coding](/docs/SYNTAX.md) for help with this.<br/>
|
||||||
|
Finally, inside characters.json should be a JSON formatted object containing all your characters. See [the documentation on characters](/docs/CHARACTERS.md) for help with this file.<br/>
|
||||||
|
|
||||||
|
## Making a story file
|
||||||
|
|
||||||
|
A story file is just a zip file of these files, so zip up story.ha, characters.json and about.json into a zip file (make sure these are in the root of the zip file).
|
||||||
|
|
||||||
|
## Playing your story
|
||||||
|
|
||||||
|
To play your story, simply run cargo run \<your zip file\>
|
||||||
@@ -0,0 +1,91 @@
|
|||||||
|
# Syntax
|
||||||
|
|
||||||
|
## Setup
|
||||||
|
|
||||||
|
This is done in the about.json file,
|
||||||
|
|
||||||
|
```
|
||||||
|
{
|
||||||
|
|
||||||
|
"title": "My Great Story",
|
||||||
|
|
||||||
|
"description": "please read!"
|
||||||
|
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Characters
|
||||||
|
|
||||||
|
See [Character documentation](/docs/CHARACTER.md) for more info
|
||||||
|
Referencing a character using the @, @NARRATOR is reserved for the Narrator.<br/>
|
||||||
|
Customisation is done with @CHARACTER change \<feature\> into \<feature name\><br/>
|
||||||
|
Move a character with @CHARACTER to fr
|
||||||
|
|
||||||
|
> [!NOTE]
|
||||||
|
> fr means front-right for instance.
|
||||||
|
|
||||||
|
## Outputs
|
||||||
|
|
||||||
|
```
|
||||||
|
@CHARACTER says "this string
|
||||||
|
is multi-line
|
||||||
|
and ends with a"
|
||||||
|
```
|
||||||
|
|
||||||
|
## Variables
|
||||||
|
|
||||||
|
Variables are referenced with the \$, only integers will be supported.<br/>
|
||||||
|
|
||||||
|
## Selection
|
||||||
|
|
||||||
|
Condition based:
|
||||||
|
|
||||||
|
```
|
||||||
|
if (condition) {
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
elif (condition) {
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
else
|
||||||
|
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Choice based:
|
||||||
|
|
||||||
|
```
|
||||||
|
choice "choice 1" {
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
or "choice 2" {
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
or "choice 3" {
|
||||||
|
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Positioning
|
||||||
|
|
||||||
|
```
|
||||||
|
@CHARACTER to position
|
||||||
|
|
||||||
|
PAN to position
|
||||||
|
```
|
||||||
|
|
||||||
|
## Other
|
||||||
|
|
||||||
|
```
|
||||||
|
label:
|
||||||
|
|
||||||
|
GOTO label
|
||||||
|
```
|
||||||
|
|
||||||
|
## Ending
|
||||||
|
|
||||||
|
`END` to exit out of the story
|
||||||
+12
-2
@@ -17,7 +17,9 @@ pub struct Character
|
|||||||
{
|
{
|
||||||
name: String,
|
name: String,
|
||||||
gender: String,
|
gender: String,
|
||||||
eye_color: String,
|
eye_color: Colour,
|
||||||
|
hair_color: Colour,
|
||||||
|
skin_color: Colour,
|
||||||
pronoun_subject: String,
|
pronoun_subject: String,
|
||||||
pronoun_object: String,
|
pronoun_object: String,
|
||||||
pronoun_deppos: String,
|
pronoun_deppos: String,
|
||||||
@@ -28,7 +30,6 @@ pub struct Character
|
|||||||
torso_shape: String,
|
torso_shape: String,
|
||||||
arm_shape: String,
|
arm_shape: String,
|
||||||
leg_shape: String,
|
leg_shape: String,
|
||||||
hair_color: String, // TODO RGB enum
|
|
||||||
clothing: Clothing,
|
clothing: Clothing,
|
||||||
}
|
}
|
||||||
#[derive(Debug,Deserialize,Serialize,Clone,Default)]
|
#[derive(Debug,Deserialize,Serialize,Clone,Default)]
|
||||||
@@ -39,6 +40,15 @@ pub struct Clothing
|
|||||||
bottom: String,
|
bottom: String,
|
||||||
shoes: String,
|
shoes: String,
|
||||||
}
|
}
|
||||||
|
#[derive(Debug,Deserialize,Serialize,Clone,Default)]
|
||||||
|
#[serde(default)]
|
||||||
|
pub struct Colour
|
||||||
|
{
|
||||||
|
red: u8,
|
||||||
|
green: u8,
|
||||||
|
blue: u8,
|
||||||
|
}
|
||||||
|
|
||||||
impl Character {
|
impl Character {
|
||||||
// Big ass ugly match case
|
// Big ass ugly match case
|
||||||
pub fn set_field(&mut self, field: &str, value: &str) -> Result<(), String> {
|
pub fn set_field(&mut self, field: &str, value: &str) -> Result<(), String> {
|
||||||
|
|||||||
+5
-5
@@ -51,7 +51,7 @@ async fn main()
|
|||||||
error!("No filename specified");
|
error!("No filename specified");
|
||||||
exit(10);
|
exit(10);
|
||||||
});
|
});
|
||||||
let file = File::open(format!("../stories/{file_name}")) // Get the file
|
let file = File::open(file_name) // Get the file
|
||||||
.unwrap_or_exit("Failed to read file.", 11);
|
.unwrap_or_exit("Failed to read file.", 11);
|
||||||
let mut archive = ZipArchive::new(file) // Open the archive
|
let mut archive = ZipArchive::new(file) // Open the archive
|
||||||
.unwrap_or_exit("Failed to open archive", 12);
|
.unwrap_or_exit("Failed to open archive", 12);
|
||||||
@@ -93,7 +93,7 @@ async fn main()
|
|||||||
|
|
||||||
// setup the parsing stuff //
|
// setup the parsing stuff //
|
||||||
// Read the file and split it into tokens
|
// Read the file and split it into tokens
|
||||||
// file read from a zip file /story.ha
|
// file read relative to current directory
|
||||||
let mut story_file = archive.by_name("story.ha")
|
let mut story_file = archive.by_name("story.ha")
|
||||||
.unwrap_or_exit("Unable to read story file", 14);
|
.unwrap_or_exit("Unable to read story file", 14);
|
||||||
let mut file_contents = String::new();
|
let mut file_contents = String::new();
|
||||||
@@ -106,18 +106,18 @@ async fn main()
|
|||||||
let space_seperated: Vec<&str> = file_contents
|
let space_seperated: Vec<&str> = file_contents
|
||||||
.split_whitespace()
|
.split_whitespace()
|
||||||
.collect();
|
.collect();
|
||||||
if ! space_seperated.contains(&"END")
|
if ! space_seperated.contains(&"END") // TODO remove
|
||||||
{
|
{
|
||||||
warn!("No END statement, story may exit unexpectedly");
|
warn!("No END statement, story may exit unexpectedly");
|
||||||
}
|
}
|
||||||
let (tokens, labels,_) = tokenise::tokenise(&space_seperated, 0)
|
let (tokens, labels,_) = tokenise::tokenise(&space_seperated, 0)
|
||||||
.unwrap_or_exit("Unable to tokenise data", 15);
|
.unwrap_or_exit("Unable to tokenise data", 15);
|
||||||
debug!("{tokens:?}");
|
debug!("{tokens:?}\n{labels:?}");
|
||||||
let data_clone2 = Arc::clone(&data_to_send);
|
let data_clone2 = Arc::clone(&data_to_send);
|
||||||
let characters_clone2 = Arc::clone(&characters);
|
let characters_clone2 = Arc::clone(&characters);
|
||||||
// Run the parsing process for the DSL
|
// Run the parsing process for the DSL
|
||||||
info!("DSL parsing begun");
|
info!("DSL parsing begun");
|
||||||
match parsing::token_parse(&tokens, &characters_clone2, &data_clone2, &rx)
|
match parsing::token_parse(&tokens, &labels, &characters_clone2, &data_clone2, &rx)
|
||||||
{
|
{
|
||||||
// Exit with error or success
|
// Exit with error or success
|
||||||
Ok(()) =>
|
Ok(()) =>
|
||||||
|
|||||||
+62
-20
@@ -21,6 +21,7 @@ mod character_parse;
|
|||||||
// Returns success or an error string
|
// Returns success or an error string
|
||||||
pub fn token_parse(
|
pub fn token_parse(
|
||||||
tokens: &[tokenise::Token],
|
tokens: &[tokenise::Token],
|
||||||
|
labels: &HashMap<String,usize>,
|
||||||
characters: &Arc<Mutex<HashMap::<String, character::Character>>>,
|
characters: &Arc<Mutex<HashMap::<String, character::Character>>>,
|
||||||
data_to_send: &Arc<Mutex<api::DataToSend>>,
|
data_to_send: &Arc<Mutex<api::DataToSend>>,
|
||||||
rx: &Receiver<(bool,usize,String)>,
|
rx: &Receiver<(bool,usize,String)>,
|
||||||
@@ -36,16 +37,29 @@ pub fn token_parse(
|
|||||||
// Run an infinite loop
|
// Run an infinite loop
|
||||||
'parse_loop: loop
|
'parse_loop: loop
|
||||||
{
|
{
|
||||||
|
debug!("Reading {index}");
|
||||||
// Get the next token
|
// Get the next token
|
||||||
let token = tokenise::get_string_token(tokens, index)?;
|
let token: String = match tokens.get(index)
|
||||||
debug!("{index}: {token}");
|
|
||||||
// The instructions are related to characters
|
|
||||||
if token.starts_with('@')
|
|
||||||
{
|
{
|
||||||
let character_name: String = token.chars().skip(1).collect();
|
Some(tokenise::Token::Keyword(s)) => s.to_string(),
|
||||||
debug!("Doing something with a character: {character_name}");
|
// Ignore closing braces and jump over opening brace blocks
|
||||||
// The index is incremented to after the character's instructions
|
Some(tokenise::Token::Bracket((bracket,new_index))) =>
|
||||||
index = match character_parse::character_parse(index+1, tokens, character_name, characters, data_to_send)
|
{
|
||||||
|
if bracket == &tokenise::Bracket::Closing
|
||||||
|
{
|
||||||
|
index += 1;
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
warn!("Unexpected brace block, jumping over...");
|
||||||
|
index = new_index + 1;
|
||||||
|
}
|
||||||
|
continue 'parse_loop
|
||||||
|
},
|
||||||
|
// Handle a character
|
||||||
|
Some(tokenise::Token::Character(character_name)) => // TODO add support for narrator
|
||||||
|
{
|
||||||
|
index = match character_parse::character_parse(index+1,tokens,character_name.to_string(),characters,data_to_send)
|
||||||
{
|
{
|
||||||
Ok(increment) => increment,
|
Ok(increment) => increment,
|
||||||
Err((err,increment)) =>
|
Err((err,increment)) =>
|
||||||
@@ -54,10 +68,18 @@ pub fn token_parse(
|
|||||||
increment
|
increment
|
||||||
},
|
},
|
||||||
};
|
};
|
||||||
|
continue 'parse_loop
|
||||||
}
|
}
|
||||||
// Miscelleneous instructions
|
Some(_) =>
|
||||||
else
|
|
||||||
{
|
{
|
||||||
|
warn!("Unexpected token");
|
||||||
|
index += 1;
|
||||||
|
continue 'parse_loop
|
||||||
|
},
|
||||||
|
None => return Err("File unexpectedly reached termination point".to_string()),
|
||||||
|
};
|
||||||
|
debug!("{index}: {token}");
|
||||||
|
// The instructions are related to characters
|
||||||
match token.to_lowercase().as_str()
|
match token.to_lowercase().as_str()
|
||||||
{
|
{
|
||||||
"end" =>
|
"end" =>
|
||||||
@@ -67,8 +89,7 @@ pub fn token_parse(
|
|||||||
},
|
},
|
||||||
"choice" =>
|
"choice" =>
|
||||||
{
|
{
|
||||||
debug!("Doing CHOICE");
|
let mut next_token: String = token;
|
||||||
let mut next_token = token;
|
|
||||||
let mut choices: Vec<String> = Vec::new();
|
let mut choices: Vec<String> = Vec::new();
|
||||||
let mut choice_indeces: Vec<usize> = Vec::new();
|
let mut choice_indeces: Vec<usize> = Vec::new();
|
||||||
while next_token == "or" || next_token == "choice"
|
while next_token == "or" || next_token == "choice"
|
||||||
@@ -78,9 +99,14 @@ pub fn token_parse(
|
|||||||
(
|
(
|
||||||
tokenise::get_string_token(tokens, index)?
|
tokenise::get_string_token(tokens, index)?
|
||||||
);
|
);
|
||||||
|
index += 1;
|
||||||
choice_indeces.push(index+1);
|
choice_indeces.push(index+1);
|
||||||
index += 2;
|
index = match tokenise::get_closing_index(tokens,index)
|
||||||
next_token = match tokenise::get_string_token(tokens, index)
|
{
|
||||||
|
Ok(new_index) => new_index + 1,
|
||||||
|
Err(_) => break,
|
||||||
|
};
|
||||||
|
next_token = match tokenise::get_keyword_token(tokens, index)
|
||||||
{
|
{
|
||||||
Ok(string) => string,
|
Ok(string) => string,
|
||||||
Err(_) => break,
|
Err(_) => break,
|
||||||
@@ -99,22 +125,38 @@ pub fn token_parse(
|
|||||||
0
|
0
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
let object = tokenise::get_object_token(tokens, choice)?; // TODO make more efficient
|
index = choice;
|
||||||
debug!("{object:?}");
|
|
||||||
// Don't propogate exit error
|
|
||||||
let _ = token_parse(object, characters, data_to_send, rx);
|
|
||||||
continue 'parse_loop
|
continue 'parse_loop
|
||||||
},
|
},
|
||||||
"or" =>
|
"or" =>
|
||||||
{
|
{
|
||||||
info!("OR command, jumping over");
|
info!("OR command, jumping over");
|
||||||
index += 2;
|
index += 2;
|
||||||
continue
|
let new_index = tokenise::get_closing_index(tokens, index)?;
|
||||||
|
index = new_index;
|
||||||
|
continue 'parse_loop
|
||||||
},
|
},
|
||||||
|
// Jump to a particular index based on a label eg GOTO character_check
|
||||||
|
"goto" =>
|
||||||
|
{
|
||||||
|
index += 1;
|
||||||
|
let label = tokenise::get_keyword_token(tokens, index)?;
|
||||||
|
index = match labels.get(&label)
|
||||||
|
{
|
||||||
|
Some(label_index) => *label_index,
|
||||||
|
None =>
|
||||||
|
{
|
||||||
|
warn!("Label {label} does not exist");
|
||||||
|
index
|
||||||
|
}
|
||||||
|
};
|
||||||
|
debug!("Jumping to {index}");
|
||||||
|
continue 'parse_loop
|
||||||
|
}
|
||||||
_ =>
|
_ =>
|
||||||
{
|
{
|
||||||
warn!("Invalid command: {token}");
|
warn!("Invalid command: {token}");
|
||||||
}
|
index += 1;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
if rx.recv().is_err()
|
if rx.recv().is_err()
|
||||||
|
|||||||
@@ -28,12 +28,9 @@ pub fn character_parse
|
|||||||
{
|
{
|
||||||
let mut sum_index: usize = index;
|
let mut sum_index: usize = index;
|
||||||
// Ensure the index is valid (the index is not beyond the vector)
|
// Ensure the index is valid (the index is not beyond the vector)
|
||||||
let token = match tokens.get(sum_index) {
|
let keyword = tokenise::get_keyword_token(tokens, sum_index)
|
||||||
Some(tokenise::Token::String(s)) => s.clone(),
|
.map_err(|err| (err, sum_index))?;
|
||||||
Some(_) => return Err(("Unexpected token".to_string(), sum_index + 1)),
|
match keyword.to_lowercase().as_str()
|
||||||
None => return Err(("File unexpectedly reached termination point".to_string(), sum_index)),
|
|
||||||
};
|
|
||||||
match token.to_lowercase().as_str()
|
|
||||||
{
|
{
|
||||||
// The character is saying something, so grab the text and pass it
|
// The character is saying something, so grab the text and pass it
|
||||||
// to the client
|
// to the client
|
||||||
@@ -51,7 +48,7 @@ pub fn character_parse
|
|||||||
"change" =>
|
"change" =>
|
||||||
{
|
{
|
||||||
sum_index += 1;
|
sum_index += 1;
|
||||||
let feature = tokenise::get_string_token(tokens, sum_index)
|
let feature = tokenise::get_keyword_token(tokens, sum_index)
|
||||||
.map_err(|err| (err, index))?;
|
.map_err(|err| (err, index))?;
|
||||||
sum_index += 1;
|
sum_index += 1;
|
||||||
let string = tokenise::get_string_token(tokens, sum_index)
|
let string = tokenise::get_string_token(tokens, sum_index)
|
||||||
@@ -69,13 +66,13 @@ pub fn character_parse
|
|||||||
"to"|"animate" =>
|
"to"|"animate" =>
|
||||||
{
|
{
|
||||||
sum_index += 1;
|
sum_index += 1;
|
||||||
let content = tokenise::get_string_token(tokens, sum_index)
|
let content = tokenise::get_keyword_token(tokens, sum_index)
|
||||||
.map_err(|err| (err, index))?;
|
.map_err(|err| (err, index))?;
|
||||||
api::modify_data(data_to_send, token.to_lowercase(), content, character_name, vec![]);
|
api::modify_data(data_to_send, keyword.to_lowercase(), content, character_name, vec![]);
|
||||||
},
|
},
|
||||||
// Catch all condition, if the instruction is unrecognised as a
|
// Catch all condition, if the instruction is unrecognised as a
|
||||||
// character command
|
// character command
|
||||||
_ => return Err((format!("Invalid command: {token}"),sum_index)),
|
_ => return Err((format!("Invalid command: {keyword}"),sum_index)),
|
||||||
}
|
}
|
||||||
sum_index += 1;
|
sum_index += 1;
|
||||||
Ok(sum_index)
|
Ok(sum_index)
|
||||||
|
|||||||
+57
-21
@@ -1,13 +1,23 @@
|
|||||||
use crate::
|
use crate::
|
||||||
{
|
{
|
||||||
exit,
|
exit,
|
||||||
|
HashMap,
|
||||||
};
|
};
|
||||||
|
|
||||||
#[derive(Debug, Clone)]
|
#[derive(Debug, Clone)]
|
||||||
pub enum Token
|
pub enum Token
|
||||||
{
|
{
|
||||||
String(String),
|
String(String),
|
||||||
Object(Vec<Self>),
|
Keyword(String), // Keywords aren't checked for validity in this stage
|
||||||
|
Identifier(String),
|
||||||
|
Bracket((Bracket,usize)), // Stores the index of the matching deliminator
|
||||||
|
Character(String),
|
||||||
|
}
|
||||||
|
#[derive(Debug,Clone,PartialEq)]
|
||||||
|
pub enum Bracket
|
||||||
|
{
|
||||||
|
Opening,
|
||||||
|
Closing,
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn get_string_token(tokens: &[Token], index: usize)
|
pub fn get_string_token(tokens: &[Token], index: usize)
|
||||||
@@ -19,12 +29,20 @@ pub fn get_string_token(tokens: &[Token], index: usize)
|
|||||||
None => Err("File unexpectedly reached termination point".to_string()),
|
None => Err("File unexpectedly reached termination point".to_string()),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
pub fn get_keyword_token(tokens: &[Token], index: usize)
|
||||||
pub fn get_object_token(tokens: &[Token], index: usize)
|
-> Result<String, String>
|
||||||
-> Result<&Vec<Token>, String>
|
|
||||||
{
|
{
|
||||||
match tokens.get(index) {
|
match tokens.get(index) {
|
||||||
Some(Token::Object(v)) => Ok(v),
|
Some(Token::Keyword(s)) => Ok(s.clone()),
|
||||||
|
Some(_) => Err("Unexpected token".to_string()),
|
||||||
|
None => Err("File unexpectedly reached termination point".to_string()),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
pub fn get_closing_index(tokens: &[Token], index: usize)
|
||||||
|
-> Result<usize, String>
|
||||||
|
{
|
||||||
|
match tokens.get(index) {
|
||||||
|
Some(Token::Bracket((_, index))) => Ok(*index), // TODO check for closing
|
||||||
Some(_) => Err("Unexpected token".to_string()),
|
Some(_) => Err("Unexpected token".to_string()),
|
||||||
None => Err("File unexpectedly reached termination point".to_string()),
|
None => Err("File unexpectedly reached termination point".to_string()),
|
||||||
}
|
}
|
||||||
@@ -34,37 +52,55 @@ pub fn get_object_token(tokens: &[Token], index: usize)
|
|||||||
// It can contain sub-objects (using recursive calls)
|
// It can contain sub-objects (using recursive calls)
|
||||||
// TODO check for END
|
// TODO check for END
|
||||||
pub fn tokenise(space_seperated: &Vec<&str>, mut index: usize)
|
pub fn tokenise(space_seperated: &Vec<&str>, mut index: usize)
|
||||||
-> Result<(Vec<Token>,Vec<(String,usize)>,usize),String>
|
-> Result<(Vec<Token>,HashMap<String,usize>,usize),String>
|
||||||
{
|
{
|
||||||
let mut tokenised_data: Vec<Token> = Vec::new();
|
let mut tokenised_data: Vec<Token> = Vec::new();
|
||||||
let mut labels: Vec<(String,usize)> = Vec::new();
|
let mut labels: HashMap<String, usize> = HashMap::new();
|
||||||
|
let mut bracket_stack: Vec<usize> = Vec::new();
|
||||||
while index < space_seperated.len()
|
while index < space_seperated.len()
|
||||||
{
|
{
|
||||||
let mut item = space_seperated[index].to_string();
|
let mut item = space_seperated[index].to_string();
|
||||||
let object: Vec<Token>;
|
// Characters
|
||||||
if item.starts_with('"') // TODO support '
|
if item.starts_with('@')
|
||||||
{
|
{
|
||||||
(index, item) = match tokenise_string(space_seperated, index)
|
let mut chars = item.chars();
|
||||||
|
chars.next();
|
||||||
|
tokenised_data.push(Token::Character(chars.as_str().to_string()));
|
||||||
|
}
|
||||||
|
// Strings
|
||||||
|
else if item.starts_with('"') // TODO support '
|
||||||
{
|
{
|
||||||
Some((index,item)) => (index,item),
|
let Some((new_index, new_item)) = tokenise_string(space_seperated, index)
|
||||||
None => exit(1),
|
else { exit(1) };
|
||||||
};
|
index = new_index;
|
||||||
|
item = new_item;
|
||||||
tokenised_data.push(Token::String(item));
|
tokenised_data.push(Token::String(item));
|
||||||
}
|
}
|
||||||
|
// Labels
|
||||||
|
else if item.ends_with(':')
|
||||||
|
{
|
||||||
|
let mut chars = item.chars();
|
||||||
|
chars.next_back();
|
||||||
|
let label = chars.as_str();
|
||||||
|
labels.insert
|
||||||
|
(
|
||||||
|
label.to_string(),
|
||||||
|
tokenised_data.len(),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
// On a new indentation level, do a recursive call
|
||||||
else if item == "{"
|
else if item == "{"
|
||||||
{
|
{
|
||||||
(object, labels, index) = match tokenise(space_seperated, index+1) // !WARNING! recursive call
|
bracket_stack.push(tokenised_data.len());
|
||||||
{
|
tokenised_data.push(Token::Bracket((Bracket::Opening,0))); // TODO fix no closing brace edge case
|
||||||
Ok((object,labels,index)) => (object,labels,index),
|
|
||||||
Err(err) => return Err(err),
|
|
||||||
};
|
|
||||||
tokenised_data.push(Token::Object(object));
|
|
||||||
}
|
}
|
||||||
else if item == "}"
|
else if item == "}"
|
||||||
{
|
{
|
||||||
return Ok((tokenised_data,labels,index));
|
let prev_index = bracket_stack.pop().unwrap(); // TODO eh
|
||||||
|
tokenised_data[prev_index] = Token::Bracket((Bracket::Opening, tokenised_data.len()));
|
||||||
|
tokenised_data.push(Token::Bracket((Bracket::Closing,prev_index)));
|
||||||
}
|
}
|
||||||
else { tokenised_data.push(Token::String(item)); }
|
else { tokenised_data.push(Token::Keyword(item)); }
|
||||||
index += 1;
|
index += 1;
|
||||||
}
|
}
|
||||||
Ok((tokenised_data, labels, 0))
|
Ok((tokenised_data, labels, 0))
|
||||||
|
|||||||
@@ -2,9 +2,9 @@
|
|||||||
"tim": {
|
"tim": {
|
||||||
"name": "Timothy Sharpshooter",
|
"name": "Timothy Sharpshooter",
|
||||||
"gender": "Male",
|
"gender": "Male",
|
||||||
"skin_color": "",
|
"skin_color": [0,0,0],
|
||||||
"eye_color": "",
|
"eye_color": [0,0,0],
|
||||||
"hair_color": "",
|
"hair_color": [0,0,0],
|
||||||
"pronoun_subject": "He",
|
"pronoun_subject": "He",
|
||||||
"pronoun_object": "Him",
|
"pronoun_object": "Him",
|
||||||
"pronoun_deppos": "His",
|
"pronoun_deppos": "His",
|
||||||
|
|||||||
+2
-13
@@ -1,25 +1,14 @@
|
|||||||
@tim says "hello world, it's a good day"
|
@tim says "hello world, it's a good day"
|
||||||
@tim change name "Timothy Fineshooter"
|
@tim change name "Timothy Fineshooter"
|
||||||
@tim change boop "Timothy Fineshooter"
|
label:
|
||||||
@tim to fr
|
|
||||||
choice "choice numero uno" {
|
choice "choice numero uno" {
|
||||||
@tim animate wave
|
|
||||||
@tim says "super sad"
|
@tim says "super sad"
|
||||||
choice "choice numero uno" {
|
|
||||||
@tim animate wave
|
|
||||||
@tim says "super sad"
|
|
||||||
}
|
|
||||||
or "choice numero duo" {
|
|
||||||
@tim says "super unsad"
|
|
||||||
}
|
|
||||||
or "choice numero tres" {
|
|
||||||
@tim says "hola mi amigos"
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
or "choice numero duo" {
|
or "choice numero duo" {
|
||||||
@tim says "super unsad"
|
@tim says "super unsad"
|
||||||
}
|
}
|
||||||
or "choice numero tres" {
|
or "choice numero tres" {
|
||||||
@tim says "hola mi amigos"
|
@tim says "hola mi amigos"
|
||||||
|
goto label
|
||||||
}
|
}
|
||||||
END
|
END
|
||||||
|
|||||||
Binary file not shown.
Reference in New Issue
Block a user