taskSavannah Administration - Tasks: task #15602, Submission of dungeon-mode

 
 

task #15602: Submission of dungeon-mode

Submitted by:  Corwin Brust <carlc>
Submitted on:  Sat 25 Apr 2020 12:47:31 AM UTC  
 
Should Start On:  Sat 25 Apr 2020 12:00:00 AM UTC Should be Finished on:  Wed 30 Sep 2020 04:00:00 AM UTC
Category:  Project Approval Priority:  5 - Normal
Status:  Done Privacy:  Public
Percent Complete:  100% Assigned to:  Amin Bandali <bandali>
Open/Closed:  Closed Effort:  0.00

Add a New Comment (Rich Markup)
   

You are not logged in

Please log in, so followups can be emailed to you.

 

( Jump to the original submission)

Sat 26 Sep 2020 08:14:29 PM UTC, comment #22: 

Approved in task #15779; closing.

Amin Bandali <bandali>
Site AdministratorIn charge of this item.
Sat 26 Sep 2020 07:54:47 PM UTC, comment #21: 

Hi Corwin,

comment #20:

>
> comment #19:
> > Thanks for your help, Corwin and Ineiev.
>
> Thanks for additional feedback and thoughts, below and all along this
> jourey Amin.
>


Cheers, you're very welcome!

>
>
> > A few remaining points needing to be addressed:
> >
> > - Ineiev pointed out to me that
> >   build/user-settings/host-data/dungeon-name/no-spoilers/general-store.org
> >   is missing a license header, which I probably had not noticed.  I also
> >   noticed that baddies.org (one level up) also lacks a license notice.
> >   Would you please add the GPLv3+ header to those files as well?
>
> Removed these, see below.
>

> > - After addressing the above, I think the only files without an explicit
> >   license notice in them would be the ones in
> >   build/user-settings/game-data/Characters/Bob.  I understand that the
> >   blanket statement added in f613a39cd25037aaad5ffb35d18bfbacd6f4dc8c
> >   was meant to address that.  But I have since learned that the files
> >   are better listed specifically in the README, as otherwise it would be
> >   too easy to add a file with a different license and/or copyright to
> >   the repository and get the licensing and copyright details wrong or
> >   just forget about.  Part of the reasoning for requiring notices in
> >   files whenever possible is to make it easier and clearer when copying
> >   these files to other packages, per "Why license notices?" of
> >   <https://www.gnu.org/l/gpl-howto.html>.
> >
> >   Other related references on this topic:
> >   <https://savannah.gnu.org/maintenance/ValidNotices/>
> >   <https://www.gnu.org/prep/maintain/html_node/Copyright-Notices.html>
>
> This seems clear and will be our approach going forward.  For the
> files in question I have removed each from master as they were from
> very early in the project and didn't relate to anything currently
> needed.


Great, thank you.

>
> >   As such, would you please explicitly mention those three txt files in
> >   the README?  It would probably help to do that in a small README in
> >   the same directory as those files to help tie things together nicely
> >   and avoid listing individual such files (if their number grows in the
> >   future) in the main README of the project.
>
> As aluded to above, we haven't yet updated the README as suggested.
> That's only because we've been able to avoid keeping any files that
> can't (and don't already) have the proper license and copyrights.  We
> are aligned to update the README to explicitly call out "stragglers"
> (files we can't or don't want to add the license and copyright
> information to, for whatever reason) and we'll udpate to call out
> exception files as soon as we have one :)
>


Sounds good!

>
> I gave a once over the entire repo and coudn't spot any files that
> don't have a license and copyright. fingers crossed
>


Awesome, thanks!  I'd also given it a pass the other day after your
latest change, and didn't see any files without license information.

I think at this point dungeon-mode is ready to be included in Savannah!
I would approve this very submission, but the corresponding 'group' for
your submission was marked for deletion by the original reviewer and
deleted after some time.  At the time I was not aware of the deletion(s)
and did not have sufficient access to reverse it either.

As such, please create a new submission with the same information
(optionally with any updates to the description etc since your original
submission) with the same name, and I'll approve after a quick final
reivew.

>
> >
> > I believe once these are taken care of we should be good to go. :-)
> >
> > Best,
> > amin
>
> Once again, thanks much for the work you (in the most general sense)
> do supporting our community.


You're most welcome, Corwin.  I'm happy to have been able to help!
Likewise thank you for bearing with me/us through the application
process. :-)

Best,
amin

Amin Bandali <bandali>
Site AdministratorIn charge of this item.
Thu 24 Sep 2020 12:04:00 AM UTC, comment #20: 

comment #19:

> Thanks for your help, Corwin and Ineiev.


Thanks for additional feedback and thoughts, below and all along this jourey Amin.

> A few remaining points needing to be addressed:
>
> - Ineiev pointed out to me that
>   build/user-settings/host-data/dungeon-name/no-spoilers/general-store.org
>   is missing a license header, which I probably had not noticed.  I also
>   noticed that baddies.org (one level up) also lacks a license notice.
>   Would you please add the GPLv3+ header to those files as well?


Removed these, see below.

 

> - After addressing the above, I think the only files without an explicit
>   license notice in them would be the ones in
>   build/user-settings/game-data/Characters/Bob.  I understand that the
>   blanket statement added in f613a39cd25037aaad5ffb35d18bfbacd6f4dc8c
>   was meant to address that.  But I have since learned that the files
>   are better listed specifically in the README, as otherwise it would be
>   too easy to add a file with a different license and/or copyright to
>   the repository and get the licensing and copyright details wrong or
>   just forget about.  Part of the reasoning for requiring notices in
>   files whenever possible is to make it easier and clearer when copying
>   these files to other packages, per "Why license notices?" of
>   <https://www.gnu.org/l/gpl-howto.html>.
>
>   Other related references on this topic:
>   <https://savannah.gnu.org/maintenance/ValidNotices/>
>   <https://www.gnu.org/prep/maintain/html_node/Copyright-Notices.html>


This seems clear and will be our approach going forward.  For the files in question I have removed each from master as they were from very early in the project and didn't relate to anything currently needed.

>   As such, would you please explicitly mention those three txt files in
>   the README?  It would probably help to do that in a small README in
>   the same directory as those files to help tie things together nicely
>   and avoid listing individual such files (if their number grows in the
>   future) in the main README of the project.


As aluded to above, we haven't yet updated the README as suggested.  That's only because we've been able to avoid keeping any files that can't (and don't already) have the proper license and copyrights.   We are aligned to update the README to explicitly call out "stragglers" (files we can't or don't want to add the license and copyright information to, for whatever reason) and we'll udpate to call out exception files as soon as we have one :)

I gave a once over the entire repo and coudn't spot any files that don't have a license and copyright. fingers crossed

>
> I believe once these are taken care of we should be good to go. :-)
>
> Best,
> amin


Once again, thanks much for the work you (in the most general sense) do supporting our community.

Corwin Brust <carlc>
Wed 23 Sep 2020 05:12:02 AM UTC, comment #19: 

Thanks for your help, Corwin and Ineiev.

A few remaining points needing to be addressed:

- Ineiev pointed out to me that
  build/user-settings/host-data/dungeon-name/no-spoilers/general-store.org
  is missing a license header, which I probably had not noticed.  I also
  noticed that baddies.org (one level up) also lacks a license notice.
  Would you please add the GPLv3+ header to those files as well?

- After addressing the above, I think the only files without an explicit
  license notice in them would be the ones in
  build/user-settings/game-data/Characters/Bob.  I understand that the
  blanket statement added in f613a39cd25037aaad5ffb35d18bfbacd6f4dc8c
  was meant to address that.  But I have since learned that the files
  are better listed specifically in the README, as otherwise it would be
  too easy to add a file with a different license and/or copyright to
  the repository and get the licensing and copyright details wrong or
  just forget about.  Part of the reasoning for requiring notices in
  files whenever possible is to make it easier and clearer when copying
  these files to other packages, per "Why license notices?" of
  <https://www.gnu.org/l/gpl-howto.html>.

  Other related references on this topic:
  <https://savannah.gnu.org/maintenance/ValidNotices/>
  <https://www.gnu.org/prep/maintain/html_node/Copyright-Notices.html>

  As such, would you please explicitly mention those three txt files in
  the README?  It would probably help to do that in a small README in
  the same directory as those files to help tie things together nicely
  and avoid listing individual such files (if their number grows in the
  future) in the main README of the project.

I believe once these are taken care of we should be good to go. :-)

Best,
amin

Amin Bandali <bandali>
Site AdministratorIn charge of this item.
Mon 14 Sep 2020 05:27:58 PM UTC, comment #18: 

comment #17:

> Hello,
>
> Docs/Maps/test.svg lacks a license notice;


Removed this file; newer image samples should include the license in the SVG source.

Thanks Ineiev!

Corwin Brust <carlc>
Mon 14 Sep 2020 12:52:46 PM UTC, comment #17: 

Hello,

Docs/Maps/test.svg lacks a license notice; since that file is an image, I would recommend putting the notices in a README file in the same directory with files in question, https://www.gnu.org/prep/maintain/html_node/Copyright-Notices.html.

Ineiev <ineiev>
Site Administrator
Tue 08 Sep 2020 02:31:36 AM UTC, comment #16: 

Thanks Corwin and Frank.

I gave your application another quick review, and it looks pretty good
to me now, and I think in terms of licenses all files are now covered.

Ineiev, would you please give this one last review?  If you don't see
any issues I will then go ahead and approve.

Thanks,
amin

Amin Bandali <bandali>
Site AdministratorIn charge of this item.
Mon 07 Sep 2020 08:36:06 PM UTC, comment #15: 

comment #14:

> [..] I look forward to hearing from you again about this soon.


Changes based on the most recent notes are completed, we think.  We did take your advice in adding a blanket statement in the license section of the README.

Look forward to your further thoughts.

Corwin Brust <carlc>
Mon 07 Sep 2020 05:31:49 AM UTC, comment #14: 

comment #13:

> comment #12:
> > Hi again Corwin,
> >
> > Following up to see if you are still interested in this.
>
> Absolutely Amin.  I've nudged the person who was going to review and complete the few items that seemed to be remaining per this task/thread.
>
> I'll take a look toward the end of the long weekend and make sure this got attended to.  Thanks for the follow-up and all of your support!


Thank you Corwin, sounds good!  You're very welcome, and I look forward to hearing from you again about this soon.

Amin Bandali <bandali>
Site AdministratorIn charge of this item.
Mon 07 Sep 2020 04:39:08 AM UTC, comment #13: 

comment #12:

> Hi again Corwin,
>
> Following up to see if you are still interested in this.


Absolutely Amin.  I've nudged the person who was going to review and complete the few items that seemed to be remaining per this task/thread.

I'll take a look toward the end of the long weekend and make sure this got attended to.  Thanks for the follow-up and all of your support!

Corwin Brust <carlc>
Sun 06 Sep 2020 03:04:04 AM UTC, comment #12: 

Hi again Corwin,

Following up to see if you are still interested in this.

Amin Bandali <bandali>
Site AdministratorIn charge of this item.
Fri 31 Jul 2020 12:53:50 AM UTC, comment #11: 

Hi Corwin,

My apologies again for the slow reply, it's been a hectic minute.

Assuming <https://github.com/dungeon-mode/game> as the current location
of your project with most recent sources, I see a few a few files
missing license notices:

  • .gitignore
  • test.svg (your Docs/battleboard/Battleboard.svg is an example of an

  svg file which does include license comments)

  • Docs/Maps/Levels/B-Maze_*.org
  • build/user-settings/* (for the tiny "Character" text files you can

  mention their license in your README.org as an alternative to adding
  a license to each one)

Once the above are addressed, I think dungeon-mode will be ready for one
last review (likely by Ineiev) and hopefully accepted onto Savannah. :-)

Thanks for your patience and cooperation,
amin

Amin Bandali <bandali>
Site AdministratorIn charge of this item.
Thu 14 May 2020 09:57:02 PM UTC, comment #10: 

comment #9:

> Thank you!
>
> Many files (e.g. README.org, Docs/Maps/testmap.org) lack copyright notices; I couldn't find copyright and license notices for files like Docs/Maps/defaultfeatures.svg and Docs/battleboard/Battleboard.odg.


Battleboard.odg is removed; all other files in the Game repo should now have a copyright line near the top of the file excepting the .el files which have the copyright line in the usual place within the boilerplate at the top of each.

Thanks so much and please let us know of anything else we should look into!

Corwin Brust <carlc>
Fri 08 May 2020 07:50:18 AM UTC, comment #9: 

Thank you!

Many files (e.g. README.org, Docs/Maps/testmap.org) lack copyright notices; I couldn't find copyright and license notices for files like Docs/Maps/defaultfeatures.svg and Docs/battleboard/Battleboard.odg.

I wonder if https://savannah.gnu.org/maintenance/ValidNotices/ and the documentation it links to could help you.

Ineiev <ineiev>
Site Administrator
Sat 02 May 2020 10:59:18 PM UTC, comment #8: 

Greetings.

The interim project repo has changed.  Sorry for any confusion this may cause!  Please review changes from this location going forward or let us know if tarballs would be simpler.

  https://github.com/dungeon-mode/game

The change was made to reduce confusion and clarify the group-owned Free Software nature of the project, as best GitHub allows.

We've completed updating all org documents to include a license, using the "short mention with link" approach described below and which, as you have mentioned, is employed by Org itself in org-mode documents (are these intended for distribution as ours are?)

As I mentioned on IRC, I also removed a number of things we haven't ended up needing, early experiments and research and so on.  If we add them back we'll add licensing, of course.  I think most if not all files should have license information at this point.

Looking forward to your additional feedback and suggestions.

Corwin Brust <carlc>
Thu 30 Apr 2020 10:48:54 PM UTC, comment #7: 

Thank you Ineiev.

Hi Amin, I appreciate your assistance.  We have already started some changes following your excellent suggestions on IRC last night (US/Central, here).  Below I'll interweave some specific notes about we have done so far, summarize what we are still working on, and add the open question we have about how best to add licensing to Org documents which constitute "Default Dungeon" (and are thus project source code in their own right).

comment #6:

> Looking at your repository, I see nearly all *.el elisp files have clear
> headers containing license and author information, which is great.  The
> only exception seems to be emacs-init-scripts/user/sample.init.el, which
> does not have a header.  Would you please add proper license and author
> information to that file as well?


This now shares the GPLv3+ boilerplate autogenerated by Emacs as for all other .el files in the project.  Thanks.

> Besides the elisp sources, proper license notices should be applied to
> all non-trivial source (non-derived) files in your project, including
> but not limited to sources for manuals and artistic work.


Our initent is to package as a literate project, so ultimately, all the boilerplate common to all elisp files will be contained in the master org-mode document or documents that generate the packaged distributables including the final .el files as well as anything we might eventually push toward MELPA, ELPA, etc.

I think that means, in the longer term, ensuring all sources have the right licensing affixed in the right way will be easier than it is going to be up-front.  That said, I'm not especially daunted by adding a license section to each Org document.

Our preference is to include, in the user facing documents that can be used to define and change game sources, a single paragraph above the first content section in each.  AFAIK this will always show the full text whether in Emacs or via any 3rd party org transformer I've run into.   This will include a link a LICENCE section elsewhere in the document which will contain the full licence verbage.

  This file is a part of dungeon-mode.  It is not a part of GNU Emacs.
  This softare is released under the GNU Public Licence version three
  or, at your disgression, any newer version of the GNU Public
  License.  For specific terms please see [[LICENSE]] at end-of-file.

> For manuals and documentation, we recommend the latest version of GFDL,
> including the "or-later" clause.  See
> https://www.gnu.org/licenses/fdl.html for a copy of the latest version
> of GFDL and tips on how to use it.


We don't yet have documentation apart from two categories, addressed in turn in the next paragraph.  As for the future, I will read about GFDL.

Current documentation is in three forms:

  • Outdated and "served it's purpose" research documentation (we can just trash these)
  • A few relivant org-documents - we can treat these as for game sources, for now.  Also many probably do contain babel blocke, eg. source, and should have the full GPLv3+ anyway.
  • narrativites in org-mode game files and docstrings in el - these are covered by above discussed approaches, I think.

> For SVG files, you can set a license for each file using Inkscape by
> opening it and going to "File > Document Properties... > License", and
> specifying a license there.
>
> In the case of binary source files, such as jpg or png images, you can
> state the license for each file in your README.org file.


As discussed we begin watermaking the SVG files with a full version of the GPLv3+ disclamer we had perviously excerpted from Emacs Lisp sources and installed into Docs/battleboard/Battleboard.svg, which I think you had agreed carries sufficient licence information.

Given that's correct, and further per our conversation I think, we'll carry that forward to other SVG graphics and also work to provide SVG versions of any remaining creative assets we don't eliminate entirely.

> For artistic files, such as game assets, you can use any GPL-compatible
> license, including CC0 or CC BY.  We naturally recommend the GPL
> itself. :-)


As we have discussed, as the creative assets form the sample game distributed with the program sources, we will treat them as per code in terms of ensuring that each unique asset carries the GPLv3+ boilerplate or, where this is not possible such as for binaries if we end up needing some, then we'll list those assets on our top-level public organs along with sufficient langauge as to confer the GPLv3+ upon those also.

>
> Please reply to the ticket once you have applied the requested changes
> so we can proceed further.


I hope I've done that sufficently here; if you are aligned to the above comments and approach we don't have additional questions at this time.  I think you can can reach me, and please do, in case of any concerns, otherwise I will update within a few days or a weeks times and hopefully to say that outstanding changes are complete.

>
> Thanks,
> amin


Thanks Amin.

Warm Regards,
Corwin

Corwin Brust <carlc>
Thu 30 Apr 2020 01:23:07 AM UTC, comment #6: 

comment #5:

> Amin, will and/or can you help them?


Yes, but this will be the very first application I review/help with.
But I guess we all need to start from somewhere. :-)  Please feel free
to jump in at any point with remarks or suggestions.

Corwin, for the purposes of this application, I will monitor the current
Git repository of your project you linked in an earlier comment of
yours, rather than requesting you to upload a new tarball for each
revision.

Looking at your repository, I see nearly all *.el elisp files have clear
headers containing license and author information, which is great.  The
only exception seems to be emacs-init-scripts/user/sample.init.el, which
does not have a header.  Would you please add proper license and author
information to that file as well?

Besides the elisp sources, proper license notices should be applied to
all non-trivial source (non-derived) files in your project, including
but not limited to sources for manuals and artistic work.

For manuals and documentation, we recommend the latest version of GFDL,
including the "or-later" clause.  See
https://www.gnu.org/licenses/fdl.html for a copy of the latest version
of GFDL and tips on how to use it.

For SVG files, you can set a license for each file using Inkscape by
opening it and going to "File > Document Properties... > License", and
specifying a license there.

In the case of binary source files, such as jpg or png images, you can
state the license for each file in your README.org file.

For artistic files, such as game assets, you can use any GPL-compatible
license, including CC0 or CC BY.  We naturally recommend the GPL
itself. :-)

Please reply to the ticket once you have applied the requested changes
so we can proceed further.

Thanks,
amin

Amin Bandali <bandali>
Site AdministratorIn charge of this item.
Tue 28 Apr 2020 05:57:49 PM UTC, comment #5: 

Amin, will and/or can you help them?

Ineiev <ineiev>
Site Administrator
Sun 26 Apr 2020 09:21:55 PM UTC, comment #4: 

I didn't realize about logging in sepeerately to savannah.nongnu.org using my savannah.gnu.org credential.  I posted the "anonymous" comment below confirming that references to "Open Source" in the documentation for our application for Savannah hosting are removed from the document stored in our present hosting and that this was the only reference to "open source" anywhere in/by our project.  

Sorry for any confusion and please let me know any additional concerns or questions.

Corwin Brust <carlc>
Sun 26 Apr 2020 08:16:39 PM UTC, comment #3: 

I have updated the document we used to prepare our application for Savannah hosting, removing references to "Open Source".  This was the only file in our project that included both "open" and "source" per grep -ir "source" | grep "open".

The updated document is pushed to master and available here:
https://github.com/mplscorwin/dungeon-mode/blob/master/Docs/savannah-app.org

Anonymous
Sun 26 Apr 2020 04:18:45 PM UTC, comment #2: 

I would like to see dungeon-mode find a home on Savannah.

Corwin, have you seen [0] and [1]?  Would you be willing to replace uses of "open source" with Free Software in your project's code and documentation?

[0]: https://savannah.gnu.org/register/requirements.php
[1]: https://savannah.gnu.org/maintenance/HowToGetYourProjectApprovedQuickly/

Amin Bandali <bandali>
Site AdministratorIn charge of this item.
Sun 26 Apr 2020 04:03:08 PM UTC, comment #1: 

Savannah as a part of the GNU Project doesn't support open source software.

Cancelling.

Ineiev <ineiev>
Site Administrator
Sat 25 Apr 2020 12:47:31 AM UTC, original submission:  

A new project has been registered at Savannah
This project account will remain inactive until a site admin approves
or discards the registration.

Registration Administration

While this item will be useful to track the registration process,
approving or discarding the registration must be done using the specific Group Administration page, accessible only to site administrators,
effectively logged as site administrators (superuser):

Registration Details

  • Name: dungeon-mode
  • System Name:  dungeon
  • Type: non-GNU software and documentation
  • License: GNU General Public License v3 or later

Description:

Create free (as in freedom) RPGs with GNU Emacs.  And then play them.

We want to:
  1. Create, publish and play RPGs without any costs now or ever.
  2. Own all our data and understand our rights when we use other
     people's content and when we share content, especially online.
  3. Learn from self-documenting software and heuristic features that
     maximize universal design opportunities improve RPG accessibility.
  4. Evangelize open-source and GNU and drive adaptation by gamers by
     providing a single open source platform e.g., whether for
     interactively joining a shared world across a network connection
     or at a table or while preparing a commercial work for binding.
  5. Play and create with the fewest possible assumptions, for example
     the presence of a window manager, access to a network, or use of
     a restricted or proprietary operating system or application.
  6. Maintain and distribute a "core" (meaning minimum original) set
     of technical components to support interactive play and authoring
     and provide a basis for creating original game experiences.
  7. Enable and support peer-to-peer and distributed content sharing
     free from any implicit oversight.  If approved, the dungeon-mode
     repository will include neither user supplied content nor game
     sources except for the "Default Dungeon" which source materials
     share the copyright and licensing terms of the of the project.
  8. If otherwise successful, enhance the GNU open-source tool-chain
     with additional audio and video conferencing capabilities
     especially for gaming and empower users to manage such streams
     from GNU Emacs and, e.g. while playing.  While these would likely
     culminate in new projects initial research may occur at this one.
  9. If otherwise successful, fork GNU Emacs and other GNU projects to
     create a mobile first information centric heuristic operating
     system focused on user freedom and privacy, e.g. to dungeon with.

Other Software Required:

GNU Emacs (probably v28 or later)
GPLv3+
https://gnu.org/software/emacs

Other Comments:

Corwin can be easily reached on irc://freenode.net/#emacs or by email, etc.

Tarball URL:

https://savannah.gnu.org/submissions_uploads/dungeon-mode-20200424-d5f44fb.tar.gz

Corwin Brust <carlc>

 

(Note: upload size limit is set to 16384 kB, after insertion of the required escape characters.)

Attach Files:
   
   
Comment:
   

No files currently attached

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -email is unavailable- added by bandali (Posted a comment)
  • -email is unavailable- added by ineiev (Posted a comment)
  • -email is unavailable- added by carlc (Submitted the item)
  •  

    Do you think this task is very important?
    If so, you can add your encouragement to it.
    This task has 0 encouragements so far.

    Only logged-in users can vote.

     

     

     

    Follow 17 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2020-09-26 bandali Open/ClosedOpen => Closed
    2020-09-26 bandali StatusIn Progress => Done
        Percent Complete90% => 100%
    2020-09-08 bandali StatusWait reply => In Progress
    2020-09-06 bandali Should be Finished on2020-08-10 => 2020-09-30
        StatusIn Progress => Wait reply
    2020-07-31 bandali Should be Finished on2020-07-31 => 2020-08-10
        Percent Complete0% => 90%
    2020-07-10 bandali Should be Finished on2020-06-01 => 2020-07-31
    2020-05-06 bandali Should be Finished on2020-05-05 => 2020-06-01
    2020-04-30 bandali Assigned toineiev => bandali
    2020-04-26 bandali StatusWait reply => In Progress
        Open/ClosedClosed => Open
    2020-04-26 bandali StatusCancelled => Wait reply
    2020-04-26 ineiev StatusNone => Cancelled
        Assigned toNone => ineiev
        Open/ClosedOpen => Closed

    Back to the top


    Powered by Savane 3.5